Methods' Summary |
getRelationCount |
Returns the number of relations in this relation set.
|
getRelation |
Returns the relation of this relation set that is specified by
the given index.
|
containsRelation |
Tests whether the relation set contains a relation matching the
specified key.
|
getRelationByType |
Retrieve and return the relation with the given relation type.
|
Methods' Details |
getRelationCount
- Description
- Returns the number of relations in this relation set.
- Returns
- Returns the number of relations or zero if there are none.
|
|
getRelation
- Description
- Returns the relation of this relation set that is specified by
the given index.
- Parameter nIndex
- This index specifies the relation to return.
- Returns
- For a valid index, i.e. inside the range 0 to the number of
relations minus one, the returned value is the requested
relation. If the index is invalid then the returned relation
has the type INVALID.
|
|
containsRelation
boolean |
containsRelation( |
[in] short |
aRelationType ); |
- Description
- Tests whether the relation set contains a relation matching the
specified key.
- Parameter aRelationType
- The type of relation to look for in this set of relations. This
has to be one of the constants of
AccessibleRelationType.
- Returns
- Returns `TRUE` if there is a (at least one) relation of the
given type and `FALSE` if there is no such relation in the set.
|
|
getRelationByType
- Description
- Retrieve and return the relation with the given relation type.
- Parameter aRelationType
- The type of the relation to return. This has to be one of the
constants of AccessibleRelationType.
- Returns
- If a relation with the given type could be found than (a copy
of) this relation is returned. Otherwise a relation with the
type INVALID is returned.
|
|
Top of Page
Copyright © 2020, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.