Interface IssueConstrainerAdminSession

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

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

For updates, IssueConstrainernFo rms are requested to the IssueConstrai ner Id that is to be updated using getIssueConstrainerFormForUpdate (). Similarly, the IssueConstrainerF orm has metadata about the data that can be updated and it can perform validation before submitting the update. The IssueConstrainerF orm can only be used once for a successful update and cannot be reused.

The delete operations delete IssueConstraine rs. To unmap an IssueConstrai ner from the current Oubliette , the IssueConstrainerOublietteeAssignmentSess ion should be used. These delete operations attempt to remove the IssueConstrai ner 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.

    • canCreateIssueConstrainers

      boolean canCreateIssueConstrainers()
      Tests if this user can create IssueConstraine rs. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an IssueConstrai ner 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 IssueConstrainer creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateIssueConstrainerWithRecordTypes

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

    • getIssueConstrainerFormForCreate

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

    • createIssueConstrainer

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

    • canUpdateIssueConstrainers

      boolean canUpdateIssueConstrainers()
      Tests if this user can update IssueConstraine rs. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an IssueConstrai ner 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 IssueConstrainer modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getIssueConstrainerFormForUpdate

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

    • updateIssueConstrainer

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

    • canDeleteIssueConstrainers

      boolean canDeleteIssueConstrainers()
      Tests if this user can delete IssueConstraine rs. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an IssueConstrai ner 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 IssueConstrainer deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteIssueConstrainer

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

    • canManageIssueConstrainerAliases

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

    • aliasIssueConstrainer

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