Constructor
API Tags:
Information Tags:
Get the lookup object if available (only on MANY-TO-MANY relations, null otherwise)
API Tags:
Information Tags:
string getRelatedClass(
[
$side = ''], string
$RC
)
|
|
Get the name of the business object class that this class is related to
Parameters:
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | IllegalArguementException |
string getRelatedClassDisplayField(
[string
$side = '']
)
|
|
Getter for the display field from the related class
Parameters:
string |
$side: |
Only required for MANY-TO-MANY relations |
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | IllegalArguementException |
string getRelatedClassDisplayFieldValue(
[string
$accessingClassName = '']
)
|
|
Getter for the display value of the related class field. In the case of a MANY-TO-MANY Relation, a comma-seperated sorted list of values is returned.
Parameters:
string |
$accessingClassName: |
Used to indicate the reading side when accessing from MANY-TO-MANY relation (leave blank for other relation types) |
API Tags:
Information Tags:
Throws: | IllegalArguementException |
Throws: | AlphaException |
Since: | 1.0 |
string getRelatedClassField(
)
|
|
Getter for the field of the related class
API Tags:
Information Tags:
array getRelatedClassHeaderFields(
)
|
|
Getter for the selection widget field headings of the related class
API Tags:
Information Tags:
array getRelatedObject(
)
|
|
For one-to-one relations, get the object on the other side
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | AlphaException |
array getRelatedObjects(
[
$accessingClassName = '']
)
|
|
For one-to-many and many-to-many relations, get the objects on the other side
string $accessingClassName Used to indicate the reading side when accessing from MANY-TO-MANY relation (leave blank for other relation types)
Parameters:
API Tags:
Information Tags:
Throws: | IllegalArguementException |
Throws: | AlphaException |
Since: | 1.0 |
string getRelationType(
)
|
|
Getter for the relation type
API Tags:
Information Tags:
Get the validation rule
API Tags:
Information Tags:
string getSide(
string
$BOClassname
)
|
|
Gets the side ('left' or 'right') of the passed classname on the current Relation object
Parameters:
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | IllegalArguementException |
Get the allowable size of the Relation in the database field
API Tags:
Information Tags:
void setRelatedClass(
string
$RC, [string
$side = '']
)
|
|
Set the name of the business object class that this class is related to
Parameters:
string |
$RC: |
|
string |
$side: |
Only required for MANY-TO-MANY relations |
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | IllegalArguementException |
void setRelatedClassDisplayField(
string
$RCDF, [string
$side = '']
)
|
|
Setter for the display field from the related class
Parameters:
string |
$RCDF: |
|
string |
$side: |
Only required for MANY-TO-MANY relations |
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | IllegalArguementException |
void setRelatedClassField(
string
$RCF
)
|
|
Setter for the field of the related class
Parameters:
API Tags:
Information Tags:
Throws: | IllegalArguementException |
Throws: | AlphaException |
Since: | 1.0 |
void setRelatedClassHeaderFields(
array
$fieldNames
)
|
|
Setter for ONE-TO-MANY relations, which sets the header fields to render from the related class
Parameters:
API Tags:
Information Tags:
void setRelationType(
string
$RT
)
|
|
Setter for the relation type
Parameters:
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | IllegalArguementException |
Throws: | IllegalArguementException |
Throws: | FailedLookupCreateException |
void setRule(
string
$rule
)
|
|
Setter to override the default validation rule
Parameters:
API Tags:
Information Tags:
void setTaggedClass(
$taggedClass
$taggedClass
)
|
|
Set the taggedClass property to the name of the tagged class when building relations to the TagObject BO.
Parameters:
$taggedClass |
$taggedClass: |
|
API Tags:
Information Tags:
void setValue(
integer
$val
)
|
|
Setter for the value (OID of related object) of this relation
Parameters:
API Tags:
Information Tags:
Since: | 1.0 |
Throws: | IllegalArguementException |
Implementation of:
- AlphaTypeInterface::setValue()
- Set the value of the type