OSID Logo
OSID Specifications
hold rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.rules.HoldEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes hold enablers. The data for create and update is provided via the HoldEnablerForm.

MethodgetOublietteId
Description

Gets the Oubliette Id associated with this session.

Returnosid.id.Idthe Oubliette Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOubliette
Description

Gets the Oubliette associated with this session.

Returnosid.hold.Oubliettethe oubliette
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateHoldEnabler
Description

Tests if this user can create hold enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a HoldEnabler 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.

Returnboolean false if HoldEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateHoldEnablerWithRecordTypes
Description

Tests if this user can create a single HoldEnabler using the desired record types. While HoldRulesManager.getHoldEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific HoldEnabler. Providing an empty array tests if a HoldEnabler can be created with no records.

Parametersosid.type.Type[]holdEnablerRecordTypesarray of hold enabler record types
Returnboolean true if HoldEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT holdEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerFormForCreate
Description

Gets the hold enabler form for creating new hold enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]holdEnablerRecordTypesarray of hold enabler record types
Returnosid.hold.rules.HoldEnablerFormthe hold enabler form
ErrorsNULL_ARGUMENT holdEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateHoldEnabler
Description

Creates a new HoldEnabler.

Parametersosid.hold.rules.HoldEnablerFormholdEnablerFormthe form for this HoldEnabler
Returnosid.hold.rules.HoldEnablerthe new HoldEnabler
ErrorsILLEGAL_STATE holdEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT holdEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED holdEnablerForm did not originate from getHoldEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateHoldEnablers
Description

Tests if this user can update hold enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a HoldEnabler 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.

Returnboolean false if HoldEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetHoldEnablerFormForUpdate
Description

Gets the hold enabler form for updating an existing hold enabler. A new hold enabler form should be requested for each update transaction.

Parametersosid.id.IdholdEnablerIdthe Id of the HoldEnabler
Returnosid.hold.rules.HoldEnablerFormthe hold enabler form
ErrorsNOT_FOUND holdEnablerId is not found
NULL_ARGUMENT holdEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateHoldEnabler
Description

Updates an existing hold enabler.

Parametersosid.hold.rules.HoldEnablerFormholdEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE holdEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT holdEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED holdEnablerForm did not originate from getHoldEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteHoldEnablers
Description

Tests if this user can delete hold enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a HoldEnabler 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.

Returnboolean false if HoldEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteHoldEnabler
Description

Deletes a HoldEnabler.

Parametersosid.id.IdholdEnablerIdthe Id of the HoldEnabler to remove
ErrorsNOT_FOUND holdEnablerId not found
NULL_ARGUMENT holdEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageHoldEnablerAliases
Description

Tests if this user can manage Id aliases for hold 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.

Returnboolean false if HoldEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasHoldEnabler
Description

Adds an Id to a HoldEnabler for the purpose of creating compatibility. The primary Id of the HoldEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another hold enabler. it is reassigned to the given hold enabler Id.

Parametersosid.id.IdholdEnablerIdthe Id of a HoldEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND holdEnablerId not found
NULL_ARGUMENT holdEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.