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

This session provides methods to apply ProfileEntryEnablers to ProfileEntries. A ProfileEntry with multiple ProfileEntryEnablers means any positive rule evaluation across the enablers result in an effective ProfileEntry.

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.
MethodcanAssignProfileEntryEnablers
Description

Tests if this user can alter profile entry enabler/profile entry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignProfileEntryEnablerToProfileEntry
Description

Tests if this user can alter profile entry enabler/profile entry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdprofileEntryIdthe Id of the ProfileEntry
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT profileEntryId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableProfileEntryIdsForProfileEntryEnabler
Description

Gets a list of profile entry in which a specific profile entry enabler can be assigned.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler
Returnosid.id.IdListlist of assignable profile entry Ids
ErrorsNULL_ARGUMENT profileEntryEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProfileEntryEnablerToProfileEntry
Description

Adds an existing ProfileEntryEnabler to a ProfileEntry.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler
osid.id.IdprofileEntryIdthe Id of the ProfileEntry
ErrorsALREADY_EXISTS profileEntryEnablerId is already applied to profileEntryId
NOT_FOUND profileEntryEnablerId or profileEntryId not found
NULL_ARGUMENT profileEntryEnablerId or profileEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignProfileEntryEnablerFromProfileEntry
Description

Removes a ProfileEntryEnabler from a ProfileEntry.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler
osid.id.IdprofileEntryIdthe Id of the ProfileEntry
ErrorsNOT_FOUND profileEntryEnablerId or profileEntryId not found or profileEntryEnablerId not applied to profileEntryId
NULL_ARGUMENT profileEntryEnablerId or profileEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceProfileEntryEnablers
Description

Tests if this user can order ProfileEntryEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if ProfileEntryEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveProfileEntryEnablerAhead
Description

Reorders profile entry enablers for a profile entry by moving the specified profile entry enabler in front of a reference profile entry enabler.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of a ProfileEntryEnabler
osid.id.IdprofileEntryIdthe Id of a ProfileEntry
osid.id.IdreferenceIdthe reference profile entry enabler Id
ErrorsNOT_FOUND profileEntryEnablerId, profileEntryId, or referenceId not found or, profileEntryEnablerId or referenceId not related to profileEntryId
NULL_ARGUMENT profileEntryEnablerId, profileEntryId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveProfileEntryEnablerBehind
Description

Reorders profile entry enablers for a profile entry by moving the specified profile entry enabler behind a reference profile entry enabler.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of a ProfileEntryEnabler
osid.id.IdprofileEntryIdthe Id of a ProfileEntry
osid.id.IdreferenceIdthe reference profile entry enabler Id
ErrorsNOT_FOUND profileEntryEnablerId, profileEntryId, or referenceId not found or, profileEntryEnablerId or referenceId not related to profileEntryId
NULL_ARGUMENT profileEntryEnablerId, profileEntryId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderProfileEntryEnablers
Description

Reorders a set of profile entry enablers for a profile entry.

Parametersosid.id.Id[]profileEntryEnablerIdsthe Ids for a set of ProfileEntryEnablers
osid.id.IdprofileEntryIdthe Id of a ProfileEntry
ErrorsNOT_FOUND profileEntryId not found or, an profileEntryEnablerId not related to profileEntryId
NULL_ARGUMENT profileEntryEnablerIds or profileEntryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.