OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.DemographicEnablerAdminSession
Implementsosid.OsidSession
Description

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

MethodgetBinId
Description

Gets the Bin Id associated with this session.

Returnosid.id.Idthe Bin Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBin
Description

Gets the Bin associated with this session.

Returnosid.resource.Binthe bin
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateDemographicEnabler
Description

Tests if this user can create demographic enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a DemographicEnabler 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 DemographicEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateDemographicEnablerWithRecordTypes
Description

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

Parametersosid.type.Type[]demographicEnablerRecordTypesarray of demographic enabler record types
Returnboolean true if DemographicEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT demographicEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetDemographicEnablerFormForCreate
Description

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

Parametersosid.type.Type[]demographicEnablerRecordTypesarray of demographic enabler record types
Returnosid.resource.demographic.DemographicEnablerFormthe demographic enabler form
ErrorsNULL_ARGUMENT demographicEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateDemographicEnabler
Description

Creates a new DemographicEnabler.

Parametersosid.resource.demographic.DemographicEnablerFormdemographicEnablerFormthe form for this DemographicEnabler
Returnosid.resource.demographic.DemographicEnablerthe new DemographicEnabler
ErrorsALREADY_EXISTSattempt at duplicating a property the underlying system is enforcing to be unique
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT demographicEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED demographicEnablerForm is not of this service
CompliancemandatoryThis method must be implemented.
MethodcanUpdateDemographicEnablers
Description

Tests if this user can update demographic enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a DemographicEnabler 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 DemographicEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanUpdateDemographicEnabler
Description

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

Parametersosid.id.IddemographicEnablerIdthe Id of the DemographicEnabler
Returnboolean false if demographic enabler modification is not authorized, true otherwise
ErrorsNULL_ARGUMENT demographicEnablerId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the demographicEnablerId is not found, then it is acceptable to return false to indicate the lack of an update available.

MethodgetDemographicEnablerFormForUpdate
Description

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

Parametersosid.id.IddemographicEnablerIdthe Id of the DemographicEnabler
Returnosid.resource.demographic.DemographicEnablerFormthe demographic enabler form
ErrorsNOT_FOUND demographicEnablerId is not found
NULL_ARGUMENT demographicEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateDemographicEnabler
Description

Updates an existing demographic enabler.

Parametersosid.id.IddemographicEnablerIdthe Id of the DemographicEnabler
osid.resource.demographic.DemographicEnablerFormdemographicEnablerFormthe form containing the elements to be updated
ErrorsINVALID_ARGUMENTthe form contains an invalid value
NOT_FOUND demographicEnablerId is not found
NULL_ARGUMENT demographicEnablerId or demographicEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED resourceEnablerProcessorForm is not of this service
CompliancemandatoryThis method must be implemented.
MethodcanDeleteDemographicEnablers
Description

Tests if this user can delete demographic enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a DemographicEnabler 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 DemographicEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanDeleteDemographicEnabler
Description

Tests if this user can delete a specified DemographicEnabler. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting the DemographicEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer a delete operation to an unauthorized user.

Parametersosid.id.IddemographicEnablerIdthe Id of the DemographicEnabler
Returnboolean false if deletion of this DemographicEnabler is not authorized, true otherwise
ErrorsNULL_ARGUMENT demographicEnablerId is null
CompliancemandatoryThis method must be implemented.
Provider Notes

If the demographicEnablerId is not found, then it is acceptable to return false to indicate the lack of a delete available.

MethoddeleteDemographicEnabler
Description

Deletes a DemographicEnabler.

Parametersosid.id.IddemographicEnablerIdthe Id of the DemographicEnabler to remove
ErrorsNOT_FOUND demographicEnablerId not found
NULL_ARGUMENT demographicEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageDemographicEnablerAliases
Description

Tests if this user can manage Id aliases for demographic 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 DemographicEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasDemographicEnabler
Description

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

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