Interface RelationshipEnablerAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface RelationshipEnablerAdminSession extends OsidSession

This session creates, updates, and deletes RelationshipEnablers . The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a RelationshipEnabler , a RelationshipEnablerForm is requested using getRelationshipEnablerFormForCreate() specifying desired record Types or none if no record Types are needed. The returned RelationshipEnablerForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the RelationshipEnablerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RelationshipEnablerForm corresponds to an attempted transaction.

For updates, RelationshipEnablerForms are requested to the RelationshipEnabler Id that is to be updated using getRelationshipEnablerFormForUpdate() . Similarly, the RelationshipEnablerForm has metadata about the data that can be updated and it can perform validation before submitting the update. The RelationshipEnablerForm can only be used once for a successful update and cannot be reused.

The delete operations delete RelationshipEnablers . To unmap a RelationshipEnabler from the current Family , the RelationshipEnablerFamilyAssignmentSession should be used. These delete operations attempt to remove the Node itself thus removing it from all known Family catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

  • Method Details

    • getFamilyId

      Id getFamilyId()
      Gets the Family Id associated with this session.
      Returns:
      the Family Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getFamily

      Family getFamily() throws OperationFailedException, PermissionDeniedException
      Gets the Family associated with this session.
      Returns:
      the family
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canCreateRelationshipEnabler

      boolean canCreateRelationshipEnabler()
      Tests if this user can create relationship enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a RelationshipEnabler will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
      Returns:
      false if RelationshipEnabler creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateRelationshipEnablerWithRecordTypes

      boolean canCreateRelationshipEnablerWithRecordTypes(Type[] relationshipEnablerRecordTypes)
      Tests if this user can create a single RelationshipEnabler using the desired record types. While RelationshipRulesManager.getRelationshipEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific RelationshipEnabler . Providing an empty array tests if a RelationshipEnabler can be created with no records.
      Parameters:
      relationshipEnablerRecordTypes - array of relationship enabler record types
      Returns:
      true if RelationshipEnabler creation using the specified record Types is supported, false otherwise
      Throws:
      NullArgumentException - relationshipEnablerRecordTypes is null
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipEnablerFormForCreate

      RelationshipEnablerForm getRelationshipEnablerFormForCreate(Type[] relationshipEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the relationship enabler form for creating new relationship enablers. A new form should be requested for each create transaction.
      Parameters:
      relationshipEnablerRecordTypes - array of relationship enabler record types
      Returns:
      the relationship enabler form
      Throws:
      NullArgumentException - relationshipEnablerRecordTypes is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - unable to get form for requested record types
      Compliance:
      mandatory - This method must be implemented.

    • createRelationshipEnabler

      RelationshipEnabler createRelationshipEnabler(RelationshipEnablerForm relationshipEnablerForm) throws OperationFailedException, PermissionDeniedException
      Creates a new RelationshipEnabler .
      Parameters:
      relationshipEnablerForm - the form for this RelationshipEnabler
      Returns:
      the new RelationshipEnabler
      Throws:
      IllegalStateException - relationshipEnablerForm already used in a create transaction
      InvalidArgumentException - one or more of the form elements is invalid
      NullArgumentException - relationshipEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - relationshipEnablerForm did not originate from getRelationshipEnablerFormForCreate()
      Compliance:
      mandatory - This method must be implemented.

    • canUpdateRelationshipEnablers

      boolean canUpdateRelationshipEnablers()
      Tests if this user can update relationship enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a RelationshipEnabler will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
      Returns:
      false if RelationshipEnabler modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipEnablerFormForUpdate

      RelationshipEnablerForm getRelationshipEnablerFormForUpdate(Id relationshipEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the relationship enabler form for updating an existing relationship enabler. A new relationship enabler form should be requested for each update transaction.
      Parameters:
      relationshipEnablerId - the Id of the RelationshipEnabler
      Returns:
      the relationship enabler form
      Throws:
      NotFoundException - relationshipEnablerId is not found
      NullArgumentException - relationshipEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • updateRelationshipEnabler

      void updateRelationshipEnabler(RelationshipEnablerForm relationshipEnablerForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing relationship enabler.
      Parameters:
      relationshipEnablerForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - relationshipEnablerForm already used in an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - relationshipEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - relationshipEnablerForm did not originate from getRelationshipEnablerFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteRelationshipEnablers

      boolean canDeleteRelationshipEnablers()
      Tests if this user can delete relationship enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a RelationshipEnabler will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
      Returns:
      false if RelationshipEnabler deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteRelationshipEnabler

      void deleteRelationshipEnabler(Id relationshipEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Deletes a RelationshipEnabler .
      Parameters:
      relationshipEnablerId - the Id of the RelationshipEnabler to remove
      Throws:
      NotFoundException - relationshipEnablerId not found
      NullArgumentException - relationshipEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageRelationshipEnablerAliases

      boolean canManageRelationshipEnablerAliases()
      Tests if this user can manage Id aliases for relationship enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
      Returns:
      false if RelationshipEnabler aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasRelationshipEnabler

      void aliasRelationshipEnabler(Id relationshipEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to a RelationshipEnabler for the purpose of creating compatibility. The primary Id of the RelationshipEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another relationship enabler. it is reassigned to the given relationship enabler Id .
      Parameters:
      relationshipEnablerId - the Id of a RelationshipEnabler
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - relationshipEnablerId not found
      NullArgumentException - relationshipEnablerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.