OSID Logo
OSID Specifications
profile rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.rules.ProfileEntryEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes profile entry enablers. The data for create and update is provided via the ProfileEntryEnablerForm.

MethodgetProfileId
Description

Gets the Profile Id associated with this session.

Returnosid.id.Idthe Profile Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetProfile
Description

Gets the Profile associated with this session.

Returnosid.profile.Profilethe profile
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateProfileEntryEnabler
Description

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

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

Parametersosid.type.Type[]profileEntryEnablerRecordTypesarray of profile entry enabler types
Returnboolean true if ProfileEntryEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT profileEntryEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetProfileEntryEnablerFormForCreate
Description

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

Parametersosid.type.Type[]profileEntryEnablerRecordTypesarray of profile entry enabler types
Returnosid.profile.rules.ProfileEntryEnablerFormthe profile entry enabler form
ErrorsNULL_ARGUMENT profileEntryEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunabel to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateProfileEntryEnabler
Description

Creates a new ProfileEntryEnabler.

Parametersosid.profile.rules.ProfileEntryEnablerFormprofileEntryEnablerFormthe form for this ProfileEntryEnabler
Returnosid.profile.rules.ProfileEntryEnablerthe new ProfileEntryEnabler
ErrorsILLEGAL_STATE profileEntryEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT profileEntryEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED profileEntryEnablerForm did not originate from getProfileEntryEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateProfileEntryEnablers
Description

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

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

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler
Returnosid.profile.rules.ProfileEntryEnablerFormthe profile entry enabler form
ErrorsNOT_FOUND profileEntryEnablerId is not found
NULL_ARGUMENT profileEntryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProfileEntryEnabler
Description

Updates an existing profile entry enabler.

Parametersosid.profile.rules.ProfileEntryEnablerFormprofileEntryEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE profileEntryEnablerForm already used in an upate transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT profileEntryEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED profileEntryEnablerForm did not originate from getProfileEntryEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteProfileEntryEnablers
Description

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

Deletes a ProfileEntryEnabler.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler to remove
ErrorsNOT_FOUND profileEntryEnablerId not found
NULL_ARGUMENT profileEntryEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageProfileEntryEnablerAliases
Description

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

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

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