oracle.panama.model
Interface Profile

All Superinterfaces:

ModelObject, XMLObject

public interface Profile

extends ModelObject

Field Summary

static int	TYPEID The type id of this class.
static java.lang.String	TYPENAME The constant class type identifier

Method Summary

Presets	createPresets(PresetCategory category) Create a user's presets relation in the category.
Presets	createPresets(PresetCategory category, java.lang.String name) Create a user's presets relation with given name in the category.
void	deletePresets(PresetCategory category, java.lang.Long id) Delete a user presets relation with given name in the specified category.
void	deletePresets(PresetCategory category, java.lang.String name) Delete a user presets relation with given name in the specified category.
int	getAccessCount(Service service) Gets the access count of a service in the profile.
Service[]	getAccessibleHomeFolderServices() Get all valid and visible services for the user's home folder.
Service[]	getAccessibleHomeFolderServicesIncludeHidden() Get all valid and visible services for the user's home folder, including those hidden in the profile
java.util.Vector	getAllPresets(PresetCategory category) Gets all of the user's presets in the given preset category.
java.sql.Timestamp	getLastAccessTime(Service service) Gets the last access time of a service in the profile.
LocationMark	getLocationMark() Gets the LocationMark for the location based profile.
java.lang.String	getName() Gets the name of the profile.
Presets	getPresets(PresetCategory category, java.lang.String name) Gets the user's presets relation with given name.
int	getSeqno(Service service) Gets the customized sequence number of a service the profile.
SortRule	getSortRule(Folder folder) Gets the sorting rule of a folder in the profile.
User	getUser() Gets the ower of the profile.
void	incrementAccessCount(Service service) Increment the access count of a service in the profile.
boolean	isHidden(Service service) Gets the customized visibility of a service in the profile.
Presets	lookupPresets(java.lang.Long id) Look up the user's preset by id.
void	resetAccessCount(Service service) Resets the access count of a service in the profile.
void	resetLastAccessTime(Service service) Resets the last access time of a service in the profile.
void	resetSortRule(Folder folder) Resets the sort rule for the folder to the system defined default sort rule.
void	setHide(Service service, boolean hide) Sets the customized visibility of a service the profile.
void	setLocationMark(LocationMark locationMark) Sets the LocationMark for the location based profile.
void	setName(java.lang.String name) Sets the name of the profile.
void	setSeqno(Service service, int seqno) Sets the customized sequence number of a service in the profile.
void	setSortRule(Folder folder, SortRule rule) Sets the sorting rule of a folder in the profile.

Methods inherited from interface oracle.panama.model.ModelObject

delete, getCreatedDate, getId, getLastModifiedDate, getTypeId, getTypeName, isSystem, setSystem, undoAll

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Field Detail

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier

See Also:

Constant Field Values

TYPEID

public static final int TYPEID

The type id of this class.

See Also:

Constant Field Values

Method Detail

getName

public java.lang.String getName()

Gets the name of the profile.

Specified by:

getName in interface ModelObject

Returns:

String the name of the object

setName

public void setName(java.lang.String name)

Sets the name of the profile.

Specified by:

setName in interface ModelObject

Parameters:

name - must be not null

getUser

public User getUser()

Gets the ower of the profile. After a profile is created by the User, client cannot change the owner of a profile.

Returns:

The User

isHidden

public boolean isHidden(Service service)

Gets the customized visibility of a service in the profile.

Returns:

The visibility property value.

setHide

public void setHide(Service service,
                    boolean hide)

Sets the customized visibility of a service the profile.

Parameters:

hide - The new value for the property.

getSeqno

public int getSeqno(Service service)

Gets the customized sequence number of a service the profile.

Returns:

The seqno property value.

setSeqno

public void setSeqno(Service service,
                     int seqno)

Sets the customized sequence number of a service in the profile.

Parameters:

seqno - The new value for the property.

getAccessCount

public int getAccessCount(Service service)

Gets the access count of a service in the profile.

Returns:

The access count property value.

resetAccessCount

public void resetAccessCount(Service service)

Resets the access count of a service in the profile.

incrementAccessCount

public void incrementAccessCount(Service service)

Increment the access count of a service in the profile.

getLastAccessTime

public java.sql.Timestamp getLastAccessTime(Service service)

Gets the last access time of a service in the profile.

Returns:

The last access time property value.

resetLastAccessTime

public void resetLastAccessTime(Service service)

Resets the last access time of a service in the profile.

getSortRule

public SortRule getSortRule(Folder folder)

Gets the sorting rule of a folder in the profile.

Returns:

The sorting rule property value.

setSortRule

public void setSortRule(Folder folder,
SortRule rule)

Sets the sorting rule of a folder in the profile.

Parameters:

rule - The new value for the property.

resetSortRule

public void resetSortRule(Folder folder)

Resets the sort rule for the folder to the system defined default sort rule.

getAccessibleHomeFolderServices

public Service[] getAccessibleHomeFolderServices()

Get all valid and visible services for the user's home folder.

Returns:

a Service[] of valid (per user) services.

getAccessibleHomeFolderServicesIncludeHidden

public Service[] getAccessibleHomeFolderServicesIncludeHidden()

Get all valid and visible services for the user's home folder, including those hidden in the profile

Returns:

a Service[] of valid (per user) services.

lookupPresets

public Presets lookupPresets(java.lang.Long id)

Look up the user's preset by id.

getAllPresets

public java.util.Vector getAllPresets(PresetCategory category)

Gets all of the user's presets in the given preset category.

Returns:

A vector of Presets

getPresets

public Presets getPresets(PresetCategory category,
                          java.lang.String name)

Gets the user's presets relation with given name.

createPresets

public Presets createPresets(PresetCategory category)

Create a user's presets relation in the category.

createPresets

public Presets createPresets(PresetCategory category,
                             java.lang.String name)

Create a user's presets relation with given name in the category.

deletePresets

public void deletePresets(PresetCategory category,
                          java.lang.String name)

Delete a user presets relation with given name in the specified category. Presets should be deleted through the user so that it can be removed from the user's cache.

deletePresets

public void deletePresets(PresetCategory category,
                          java.lang.Long id)

Delete a user presets relation with given name in the specified category. Presets should be deleted through the user so that it can be removed from the user's cache.

getLocationMark

public LocationMark getLocationMark()

Gets the LocationMark for the location based profile.

Returns:

The location mark.

setLocationMark

public void setLocationMark(LocationMark locationMark)
                     throws PanamaException

Sets the LocationMark for the location based profile.

Parameters:

locationMark - The locationMark of the profile.

PanamaException