Interface RaceProcessorEnablerAdminSession

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

This session creates and removes race processor enablers. The data for create and update is provided via the RaceProcessorEnablerForm .

  • Method Details

    • getPollsId

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

    • getPolls

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

    • canCreateRaceProcessorEnabler

      boolean canCreateRaceProcessorEnabler()
      Tests if this user can create race processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a RaceProcessorEnabler 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 RaceProcessorEnabler creation is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • canCreateRaceProcessorEnablerWithRecordTypes

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

    • getRaceProcessorEnablerFormForCreate

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

    • createRaceProcessorEnabler

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

    • canUpdateRaceProcessorEnablers

      boolean canUpdateRaceProcessorEnablers()
      Tests if this user can update race processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a RaceProcessorEnabler 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 RaceProcessorEnabler modification is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRaceProcessorEnablerFormForUpdate

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

    • updateRaceProcessorEnabler

      void updateRaceProcessorEnabler(RaceProcessorEnablerForm raceProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
      Updates an existing race processor enabler.
      Parameters:
      raceProcessorEnablerForm - the form containing the elements to be updated
      Throws:
      IllegalStateException - raceProcessorEnablerForm already used for an update transaction
      InvalidArgumentException - the form contains an invalid value
      NullArgumentException - raceProcessorEnablerForm is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - raceProcessorEnablerForm did not originate from getRaceProcessorrEnablerFormForUpdate()
      Compliance:
      mandatory - This method must be implemented.

    • canDeleteRaceProcessorEnablers

      boolean canDeleteRaceProcessorEnablers()
      Tests if this user can delete race processor enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a RaceProcessorEnabler 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 RaceProcessorEnabler deletion is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • deleteRaceProcessorEnabler

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

    • canManageRaceProcessorEnablerAliases

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

    • aliasRaceProcessorEnabler

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