Interface IssueConstrainerEnablerAdminSession

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

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

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

The delete operations delete IssueConstrainerEnablers . To unmap an IssueConstrainerEnabler from the current Oubliette , the IssueConstrainerEnablerOublietteAssignmentSession should be used. These delete operations attempt to remove the IssueConstrainerEnabler 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.

    • canCreateIssueConstrainerEnablers

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

    • canCreateIssueConstrainerEnablerWithRecordTypes

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

    • getIssueConstrainerEnablerFormForCreate

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

    • createIssueConstrainerEnabler

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

    • canUpdateIssueConstrainerEnablers

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

    • getIssueConstrainerEnablerFormForUpdate

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

    • updateIssueConstrainerEnabler

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

    • canDeleteIssueConstrainerEnablers

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

    • deleteIssueConstrainerEnabler

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

    • canManageIssueConstrainerEnablerAliases

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

    • aliasIssueConstrainerEnabler

      void aliasIssueConstrainerEnabler(Id issueConstrainerEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
      Adds an Id to an IssueConstrainerEnabler for the purpose of creating compatibility. The primary Id of the IssueConstrainerEnabler 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 constrainer enabler, it is reassigned to the given issue constrainer enabler Id.
      Parameters:
      issueConstrainerEnablerId - the Id of an IssueConstrainerEnabler
      aliasId - the alias Id
      Throws:
      AlreadyExistsException - aliasId is already assigned
      NotFoundException - issueConstrainerEnablerId not found
      NullArgumentException - issueConstrainerEnablerId or aliasId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.