Interface IssueEnablerAdminSession

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

This session creates, updates, and deletes IssueEnablers . 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 an IssueEnabler , an IssueEnablerForm is requested using getIssueEnablerFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned IssueEnablernForm 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 IssueEnablerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each IssueEnablernForm corresponds to an attempted transaction.

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

The delete operations delete IssueEnablers . To unmap an IssueEnabler from the current Oubliette , the IssueEnablerOublietteeAssignmentSession should be used. These delete operations attempt to remove the IssueEnabler itself thus removing it from all known Oubliette catalogs.

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

  • Method Details

    • getOublietteId

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

    • getOubliette

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

    • canCreateIssueEnablers

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

    • canCreateIssueEnablerWithRecordTypes

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

    • getIssueEnablerFormForCreate

      IssueEnablerForm getIssueEnablerFormForCreate(Type[] issueEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
      Gets the issue enabler form for creating new issue enablers. A new form should be requested for each create transaction.
      Parameters:
      issueEnablerRecordTypes - array of issue enabler record types
      Returns:
      the issue enabler form
      Throws:
      NullArgumentException - issueEnablerRecordTypes 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.

    • createIssueEnabler

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

    • canUpdateIssueEnablers

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

    • getIssueEnablerFormForUpdate

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

    • updateIssueEnabler

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

    • canDeleteIssueEnablers

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

    • deleteIssueEnabler

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

    • canManageIssueEnablerAliases

      boolean canManageIssueEnablerAliases()
      Tests if this user can manage Id aliases for IssueEnablers 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 IssueEnabler aliasing is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • aliasIssueEnabler

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