|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A RowDescriptor instance describes the metadata definition for a Row object. It provides access to the following:
Example usage:
Where parentRow is a Row
RowDescriptor rowDesc = parentRow.getRowDescriptor();
//To get a FieldDescriptor of a Field.
FieldDescriptor fieldDesc = rowDesc.getFieldDescriptor("field name");
//To get the row name
String rowName = rowDesc.getRowName();
//To check if this is mandatory
boolean mandatory = rowDesc.isMandatory();
//To get the field descriptor of the key field
FieldDescriptor fieldDescKey = rowDesc.getKeyFieldDescriptor();
Method Summary | |
FieldDescriptorIterator |
getAllFieldDescriptors()
Returns all FieldDescriptor instances belonging to this RowDescriptor instance |
int |
getFieldCount()
Returns the number of fields in the Row defined by this RowDescriptor |
FieldDescriptor |
getFieldDescriptor(java.lang.String fieldName)
Returns the FieldDescriptor instance for the speficied field name |
int |
getFieldIndex(FieldDescriptor fieldDescriptor)
Returns the index number of the field attribute for the specified FieldDescriptor |
FieldDescriptor |
getKeyFieldDescriptor()
Returns the key field's FieldDescriptor. |
RelationDescriptorIterator |
getRelatingRelations()
Returns all RelationDescriptor instances which are relating to the Row defined by this RowDescriptor. |
java.lang.String |
getRowName()
Returns the name of the Row defined by this RowDescriptor |
SyncBoDescriptor |
getSyncBoDescriptor()
Returns the SyncBoDescriptor instance this RowDescriptor instance belongs. |
boolean |
hasFieldDescriptor(FieldDescriptor fieldDescriptor)
Returns a boolean value indicating whether the specified FieldDescriptor is a member of this RowDescriptor instance. |
boolean |
isMandatory()
Returns the boolean attribute value indicating whether the Row object defined by this RowDescriptor is mandatory or not. |
boolean |
isTop()
Returns a boolean value indicating whether this RowDescriptor is a TOP RowDescriptor. |
Method Detail |
public java.lang.String getRowName()
public boolean isMandatory()
NOTE:
On SP2, this permission flag is not used on any data validity tests as the corresponding server-side component that validates/implements this feature is not yet available.
public FieldDescriptor getKeyFieldDescriptor()
public FieldDescriptor getFieldDescriptor(java.lang.String fieldName)
fieldName
- the name of the field
public FieldDescriptorIterator getAllFieldDescriptors()
public RelationDescriptorIterator getRelatingRelations()
public SyncBoDescriptor getSyncBoDescriptor()
public int getFieldCount()
public int getFieldIndex(FieldDescriptor fieldDescriptor)
fieldDescriptor
- the specified FieldDescriptor
public boolean hasFieldDescriptor(FieldDescriptor fieldDescriptor)
fieldDescriptor
- the FieldDescriptor instance that is to be checked.
public boolean isTop()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |