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

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

Moving or adding a reference of a ProfileEntry to another Profile is not a copy operation (eg: does not change its Id ).

MethodcanAssignProfileEntries
Description

Tests if this user can alter profile entry/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 assignment operations to unauthorized users.

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

Tests if this user can alter profile entry/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 assignment 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 profile including and under the given profile node in which any profile entry 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.
MethodgetAssignableProfileIdsForProfileEntry
Description

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

Parametersosid.id.IdprofileIdthe Id of the Profile
osid.id.IdprofileEntryIdthe Id of the ProfileEntry
Returnosid.id.IdListlist of assignable profile Ids
ErrorsNULL_ARGUMENT profileId or profileEntryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignProfileEntryToProfile
Description

Adds an existing ProfileEntry to a Profile.

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

Removes a ProfileEntry from a Profile.

Parametersosid.id.IdprofileEntryIdthe Id of the ProfileEntry
osid.id.IdprofileIdthe Id of the Profile
ErrorsNOT_FOUND profileEntryId or profileId not found or profileEntryId not assigned to profileId
NULL_ARGUMENT profileEntryId or profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignProfileEntryToProfile
Description

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

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