Interface RelationshipRulesProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
RelationshipRulesManager, RelationshipRulesProxyManager
public interface RelationshipRulesProfile extends OsidProfile

The relationship rules profile describes the interoperability among relationship rules services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerLookup

      boolean supportsRelationshipEnablerLookup()
      Tests if looking up relationship enablers is supported.
      Returns:
      true if relationship enabler lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerQuery

      boolean supportsRelationshipEnablerQuery()
      Tests if querying relationship enablers is supported.
      Returns:
      true if relationship enabler query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerSearch

      boolean supportsRelationshipEnablerSearch()
      Tests if searching relationship enablers is supported.
      Returns:
      true if relationship enabler search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerAdmin

      boolean supportsRelationshipEnablerAdmin()
      Tests if a relationship enabler administrative service is supported.
      Returns:
      true if relationship enabler administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerNotification

      boolean supportsRelationshipEnablerNotification()
      Tests if a relationship enabler notification service is supported.
      Returns:
      true if relationship enabler notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerFamily

      boolean supportsRelationshipEnablerFamily()
      Tests if a relationship enabler family lookup service is supported.
      Returns:
      true if a family enabler family lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerFamilyAssignment

      boolean supportsRelationshipEnablerFamilyAssignment()
      Tests if a relationship enabler family service is supported.
      Returns:
      true if relationship enabler family assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerSmartFamily

      boolean supportsRelationshipEnablerSmartFamily()
      Tests if a relationship enabler smart family service is supported.
      Returns:
      true if a relationship enabler smart family service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerRuleLookup

      boolean supportsRelationshipEnablerRuleLookup()
      Tests if a relationship enabler rule lookup service is supported.
      Returns:
      true if a relationship enabler relationship rule lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerRuleApplication

      boolean supportsRelationshipEnablerRuleApplication()
      Tests if a relationship enabler rule application service is supported.
      Returns:
      true if enabler relationship rule application service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipEnablerRecordTypes

      TypeList getRelationshipEnablerRecordTypes()
      Gets the supported RelationshipEnabler record types.
      Returns:
      a list containing the supported RelationshipEnabler record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerRecordType

      boolean supportsRelationshipEnablerRecordType(Type relationshipEnablerRecordType)
      Tests if the given RelationshipEnabler record type is supported.
      Parameters:
      relationshipEnablerRecordType - a Type indicating a RelationshipEnabler record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - relationshipEnablerRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipEnablerSearchRecordTypes

      TypeList getRelationshipEnablerSearchRecordTypes()
      Gets the supported RelationshipEnabler search record types.
      Returns:
      a list containing the supported RelationshipEnabler search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipEnablerSearchRecordType

      boolean supportsRelationshipEnablerSearchRecordType(Type relationshipEnablerSearchRecordType)
      Tests if the given RelationshipEnabler search record type is supported.
      Parameters:
      relationshipEnablerSearchRecordType - a Type indicating a RelationshipEnabler search record type
      Returns:
      true if the given search record type is supported, false otherwise
      Throws:
      NullArgumentException - relationshipEnablerSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.