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

This session provides methods to re-assign ProfileEntryEnabler to Profile mappings. A ProfileEntryEnabler may appear in multiple Profile objects and removing the last reference to a ProfileEntryEnabler is the equivalent of deleting it. Each Profile may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a ProfileEntryEnabler to another Profile is not a copy operation (eg: does not change its Id ).

MethodcanAssignProfileEntryEnablers
Description

Tests if this user can alter profile entry enabler/profile 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.
MethodcanAssignProfileEntryEnablersToProfile
Description

Tests if this user can alter profile entry enabler/profile 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.IdprofileIdthe Id of the Profile
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT profileId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableProfileIds
Description

Gets a list of profiles including and under the given profile node in which any profile entry enabler can be assigned.

Parametersosid.id.IdprofileIdthe Id of the Profile
Returnosid.id.IdListlist of assignable profile Ids
ErrorsNULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableProfileIdsForProfileEntryEnabler
Description

Gets a list of profiles including and under the given profile node in which a specific profile entry enabler can be assigned.

Parametersosid.id.IdprofileIdthe Id of the Profile
osid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler
Returnosid.id.IdListlist of assignable profile Ids
ErrorsNULL_ARGUMENT profileId or profileEntryEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProfileEntryEnablerToProfile
Description

Adds an existing ProfileEntryEnabler to a Profile.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler
osid.id.IdprofileIdthe Id of the Profile
ErrorsALREADY_EXISTS profileEntryEnablerId is already assigned to profileId
NOT_FOUND profileEntryEnablerId or profileId not found
NULL_ARGUMENT profileEntryEnablerId or profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignProfileEntryEnablerFromProfile
Description

Removes a ProfileEntryEnabler from a Profile.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler
osid.id.IdprofileIdthe Id of the Profile
ErrorsNOT_FOUND profileEntryEnablerId or profileId not found or profileEntryEnablerId not assigned to profileId
NULL_ARGUMENT profileEntryEnablerId or profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignProfileEntryEnablerToProfile
Description

Moves a ProfileEntryEnabler from one Profile to another. Mappings to other Profiles are unaffected.

Parametersosid.id.IdprofileEntryEnablerIdthe Id of the ProfileEntryEnabler
osid.id.IdfromProfileIdthe Id of the current Profile
osid.id.IdtoProfileIdthe Id of the destination Profile
ErrorsNOT_FOUND profileEntryEnablerId, fromProfileId, or toProfileId not found or profileEntryEnablerId not mapped to fromProfileId
NULL_ARGUMENT profileEntryEnablerId, fromProfileId, or toProfileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.