public interface RelationshipProfile extends OsidProfile
The relationship profile describes the interoperability among relationship services.
Modifier and Type | Method and Description |
---|---|
TypeList |
getFamilyRecordTypes()
Gets the supported
Family record types. |
TypeList |
getFamilySearchRecordTypes()
Gets the supported
Family search record types. |
TypeList |
getRelationshipRecordTypes()
Gets the supported
Relationship record types. |
TypeList |
getRelationshipSearchRecordTypes()
Gets the supported
Relationship search record types. |
boolean |
supportsFamilyAdmin()
Tests if family
administrative service is supported. |
boolean |
supportsFamilyHierarchy()
Tests for the availability of a family hierarchy traversal service.
|
boolean |
supportsFamilyHierarchyDesign()
Tests for the availability of a family hierarchy design service.
|
boolean |
supportsFamilyLookup()
Tests if looking up families is supported.
|
boolean |
supportsFamilyNotification()
Tests if a family notification service is supported.
|
boolean |
supportsFamilyQuery()
Tests if querying families is supported.
|
boolean |
supportsFamilyRecordType(Type familyRecordType)
Tests if the given
Family record type is supported. |
boolean |
supportsFamilySearch()
Tests if searching families is supported.
|
boolean |
supportsFamilySearchRecordType(Type familySearchRecordType)
Tests if the given
Family search record type is
supported. |
boolean |
supportsRelationshipAdmin()
Tests if relationship administrative service is supported.
|
boolean |
supportsRelationshipBatch()
Tests for the availability of a relationship batch service.
|
boolean |
supportsRelationshipFamily()
Tests if a relationship family cataloging service is supported.
|
boolean |
supportsRelationshipFamilyAssignment()
Tests if a relationship cataloging service is supported.
|
boolean |
supportsRelationshipLookup()
Tests if looking up relationships is supported.
|
boolean |
supportsRelationshipNotification()
Tests if a relationship notification service is supported.
|
boolean |
supportsRelationshipQuery()
Tests if querying relationships is supported.
|
boolean |
supportsRelationshipRecordType(Type relationshipRecordType)
Tests if the given
Relationship record type is
supported. |
boolean |
supportsRelationshipRules()
Tests if a relationship rules service is supported.
|
boolean |
supportsRelationshipSearch()
Tests if searching relationships is supported.
|
boolean |
supportsRelationshipSearchRecordType(Type relationshipSearchRecordType)
Tests if the given
Relationship search record type is
supported. |
boolean |
supportsRelationshipSmartFamily()
Tests if a relationship smart family cataloging service is supported.
|
boolean |
supportsVisibleFederation()
Tests if any family federation is exposed.
|
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
boolean supportsVisibleFederation()
true
if visible federation is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipLookup()
true
if relationship lookup is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipQuery()
true
if relationship query is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipSearch()
true
if relationship search is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipAdmin()
true
if relationship administration is
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipNotification()
true
if relationship notification is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipFamily()
true
if relationship families are supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipFamilyAssignment()
true
if relationship families are supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipSmartFamily()
true
if relationship smart families are
supported, false
otherwisemandatory
- This method must be implemented. boolean supportsFamilyLookup()
true
if family lookup is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsFamilyQuery()
true
if family query is supported, false
otherwisemandatory
- This method must be implemented. boolean supportsFamilySearch()
true
if family search is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsFamilyAdmin()
administrative service is supported. true
if family administration is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsFamilyNotification()
true
if family notification is supported,
false
otherwisemandatory
- This method must be implemented. boolean supportsFamilyHierarchy()
true
if family hierarchy traversal is
available, false
otherwisemandatory
- This method must be implemented in all
providers. boolean supportsFamilyHierarchyDesign()
true
if family hierarchy design is available,
false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipBatch()
true
if a relationship batch service is
available, false
otherwisemandatory
- This method must be implemented. boolean supportsRelationshipRules()
true
if relationship rules service is
supported, false
otherwisemandatory
- This method must be implemented. TypeList getRelationshipRecordTypes()
Relationship
record types. Relationship
record typesmandatory
- This method must be implemented. boolean supportsRelationshipRecordType(Type relationshipRecordType)
Relationship
record type is
supported.relationshipRecordType
- a Type
indicating a
Relationship
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- relationshipRecordType
is null
mandatory
- This method must be implemented. TypeList getRelationshipSearchRecordTypes()
Relationship
search record types. Relationship
search record typesmandatory
- This method must be implemented. boolean supportsRelationshipSearchRecordType(Type relationshipSearchRecordType)
Relationship
search record type is
supported.relationshipSearchRecordType
- a Type
indicating
a Relationship
search record type true
if the given search record type is
supported, false
otherwiseNullArgumentException
-
relationshipSearchRecordType
is null
mandatory
- This method must be implemented. TypeList getFamilyRecordTypes()
Family
record types. Family
typesmandatory
- This method must be implemented. boolean supportsFamilyRecordType(Type familyRecordType)
Family
record type is supported.familyRecordType
- a Type
indicating a
Family
record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- familyRecordType
is null
mandatory
- This method must be implemented. TypeList getFamilySearchRecordTypes()
Family
search record types. Family
search
record typesmandatory
- This method must be implemented. boolean supportsFamilySearchRecordType(Type familySearchRecordType)
Family
search record type is
supported.familySearchRecordType
- a Type
indicating a
Family
search record type true
if the given Type
is
supported, false
otherwiseNullArgumentException
- familySearchRecordType
is null
mandatory
- This method must be implemented.