oracle.panama.model
Interface Service

All Superinterfaces:

ModelObject, XMLObject

All Known Subinterfaces:

Alert, AsyncService, DeliveryService, ExternalLink, Folder, Link, LocalModule, MasterService, Module

public interface Service

extends ModelObject

The Service is an "abstract" interface and handles all generic aspects of a service.

Field Summary

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

Method Summary

void	addDeviceGroup(DeviceGroup group) Add a device group to the service.
void	addDeviceGroup(DeviceGroup group, boolean isExclusive) Add a device group to the service.
void	addDeviceGroup(DeviceGroup group, boolean isExclusive, Operator OP) Add a device group to the service.
Presets	createPresets(PresetCategory category) Create service's presets relation in the category.
Presets	createPresets(PresetCategory category, java.lang.String name) Create service's presets relation with given name in the category.
void	deletePresets(PresetCategory category, java.lang.Long id) Delete a service's presets relation with given id in the given category.
void	deletePresets(PresetCategory category, java.lang.String name) Delete a service's presets relation with given name in the given category.
java.lang.String	getAdminURL() Gets the URL to the admin page for this module.
java.util.Vector	getAllPresets(PresetCategory category) Gets the serivce's presets for all services in the given preset category.
long	getAreaId() Gets the areaId property (long) value.
int	getCategory() Get the Folder category.
int	getCost() get cost for the Service
java.lang.String	getCustomizationPageURL() Gets the customization page url a Service.
java.lang.String	getDescription()
DeviceGroupAssociation[]	getDeviceGroupAssociations() Return an array of the device group that the service allows access to.
Group[]	getGroups()
Folder	getParent() Get the parent folder of this service.
Presets	getPresets(PresetCategory category, java.lang.Long id) Gets the service's presets relation with given id.
Presets	getPresets(PresetCategory category, java.lang.String name) Gets the service's presets relation with given name.
java.lang.String	getPrimaryAudio() Gets the primary audio property (String) value.
java.lang.String	getPrimaryImage() Gets the primary image property (String) value.
java.lang.String	getSecondaryAudio() Gets the secondary audio property (String) value.
java.lang.String	getSecondaryImage() Gets the secondary image property (String) value.
int	getSequenceNo()
ServiceAccessPoint[]	getServiceAccessPoints()
java.lang.String	getShortName() Gets the shortName for a Service.
Transformer	getTransformer(Device device) A service can override a device default transformer.
java.lang.String	getURL()
java.lang.String	getURLPathParameter() Returns the URL to the Service.
java.lang.String	getURLPathParameter(Request request) Returns the URL to the Service.
User	getUserOwner()
java.lang.String	getVirtualURL() Gets the virtual URL for this module.
void	invoke(ServiceContext context) Invokes a Service.
boolean	isRedirectHelp()
boolean	isSessionless() Is the service sessionless?
boolean	isValid()
boolean	isViewCustomizable() Gets the view customizability status
boolean	isVisible()
void	removeAllDeviceGroups() Remove all the device group assocations with the service.
void	removeAllGroups() Remove the current service from all groups it is belongs to
void	setAdminURL(java.lang.String url) Sets the URL to the admin page for this module.
void	setAreaId(long areaId) Sets the areaId property (long) value.
void	setCategory(int category) Set the Folder category.
void	setCost(int cost) Set cost for the Service.
void	setCustomizationPageURL(java.lang.String url) Sets the customization page url a Service.
void	setDescription(java.lang.String description)
void	setGroups(Group[] groups)
void	setParent(Folder parent) Move this service into a folder.
void	setPrimaryAudio(java.lang.String primaryAudio) Sets the primary audio property (String) value.
void	setPrimaryImage(java.lang.String primaryImage) Sets the primary image property (String) value.
void	setRedirectHelp(boolean redirectHelp)
void	setSecondaryAudio(java.lang.String secondaryAudio) Sets the secondary audio property (String) value.
void	setSecondaryImage(java.lang.String secondaryImage) Sets the secondary image property (String) value.
void	setSequenceNo(int sequenceNo) Sets the sequence number for ordering.
void	setShortName(java.lang.String shortName) Sets the shortName for a Service.
void	setUserOwner(User user) Set the owner of this service.
void	setValid(boolean valid) Allow the administrator to set a service to valid or invalid.
void	setViewCustomizable(boolean value) Sets the view customizability status
void	setVirtualURL(java.lang.String url) Sets the virtual URL for this module.
void	setVisible(boolean visible) Allow the administrator to set the visibility of a service.

Methods inherited from interface oracle.panama.model.ModelObject

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

Methods inherited from interface oracle.panama.model.XMLObject

setXML, toXML

Field Detail

CATEGORY_MASTER

public static final int CATEGORY_MASTER

See Also:

Constant Field Values

CATEGORY_SERVICE

public static final int CATEGORY_SERVICE

See Also:

Constant Field Values

CATEGORY_USER_HOME

public static final int CATEGORY_USER_HOME

See Also:

Constant Field Values

TYPEID

public static final int TYPEID

The type id of this class.

See Also:

Constant Field Values

TYPENAME

public static final java.lang.String TYPENAME

The constant class type identifier

See Also:

Constant Field Values

Method Detail

addDeviceGroup

public void addDeviceGroup(DeviceGroup group)

Add a device group to the service. The device group would be added with the exclusive flag set to false, and the operator is set to null.

Parameters:

group - The device group to be added to the service.

See Also:

addDeviceGroup(DeviceGroup, boolean), addDeviceGroup(DeviceGroup, boolean, Operator)

addDeviceGroup

public void addDeviceGroup(DeviceGroup group,
                           boolean isExclusive)

Add a device group to the service. The device group would be added with the exclusive flag set to given value, and the operator is set to null.

Parameters:

group - The device group to be added to the service.

isExclusive - Whether the device group should be included or excluded. This is kind of like the NOT operator in boolean logic.

See Also:

addDeviceGroup(DeviceGroup), addDeviceGroup(DeviceGroup, boolean, Operator)

addDeviceGroup

public void addDeviceGroup(DeviceGroup group,
                           boolean isExclusive,
                           Operator OP)

Add a device group to the service. The device group would be added with the exclusive flag set to given value, and the operator is set to null.

Parameters:

group - The device group to be added to the service.

isExclusive - Whether the device group should be included or excluded.

OP - The operator to be used between this device group and the next device group to be added.

See Also:

addDeviceGroup(DeviceGroup, boolean), addDeviceGroup(DeviceGroup)

createPresets

public Presets createPresets(PresetCategory category)

Create service's presets relation in the category.

createPresets

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

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

deletePresets

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

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

deletePresets

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

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

getAdminURL

public java.lang.String getAdminURL()

Gets the URL to the admin page for this module.

Returns:

String the URL to the admin page for this module.

getAllPresets

public java.util.Vector getAllPresets(PresetCategory category)

Gets the serivce's presets for all services in the given preset category.

Returns:

A vector of Presets

getAreaId

public long getAreaId()

Gets the areaId property (long) value.

Returns:

The areaId property value.

See Also:

setAreaId(long)

getCategory

public int getCategory()

Get the Folder category. It is one of the predefined types:

• CATEGORY_SERVICE
• CATEGORY_MASTER
• CATEGORY_USER_HOME

Returns:

int the Folder category

See Also:

setCategory(int)

getCost

public int getCost()

get cost for the Service

Returns:

cost

getCustomizationPageURL

public java.lang.String getCustomizationPageURL()

Gets the customization page url a Service.

Returns:

the customization page url

getDescription

public java.lang.String getDescription()

Returns:

the description or null if not set.

getDeviceGroupAssociations

public DeviceGroupAssociation[] getDeviceGroupAssociations()

Return an array of the device group that the service allows access to.

Returns:

an array of the device group that the service allows access to. An empty array would be returned in case that there is no device group associated with the service.

getGroups

public Group[] getGroups()

Returns:

Group[] the groups the service belongs to.

See Also:

setGroups(oracle.panama.model.Group[])

getParent

public Folder getParent()

Get the parent folder of this service.

Returns:

the folder or null if none (root).

getPresets

public Presets getPresets(PresetCategory category,
                          java.lang.Long id)

Gets the service's presets relation with given id.

getPresets

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

Gets the service's presets relation with given name.

getPrimaryAudio

public java.lang.String getPrimaryAudio()

Gets the primary audio property (String) value.

getPrimaryImage

public java.lang.String getPrimaryImage()

Gets the primary image property (String) value.

getSecondaryAudio

public java.lang.String getSecondaryAudio()

Gets the secondary audio property (String) value.

getSecondaryImage

public java.lang.String getSecondaryImage()

Gets the secondary image property (String) value.

getSequenceNo

public int getSequenceNo()

Returns:

the sequence number used for ordering.

getServiceAccessPoints

public ServiceAccessPoint[] getServiceAccessPoints()

Returns:

ServiceAccessPoint[] the ServiceAccessPoint the service belongs to.

getShortName

public java.lang.String getShortName()

Gets the shortName for a Service. The shortName should be unique for a user. Used when invoked from a SMS.

Returns:

the shortName

getTransformer

public Transformer getTransformer(Device device)

A service can override a device default transformer.

Returns:

the transformer for this service if overrided the service specific transformer is returned, otherwise the default transformer for this device is returned.

getURL

public java.lang.String getURL()

Returns:

the derived and unqiue path to this service.

getURLPathParameter

public java.lang.String getURLPathParameter()

Returns the URL to the Service. The URL can be of 2 kinds:

• A relative URL Ex. ParmImp?PAservicepath=/master/getQuote.
• An absolute URL. Ex. http://www.oracle.com/new.html

NB. A service in this context can be an external link.

Returns:

a string which point to the service.

getURLPathParameter

public java.lang.String getURLPathParameter(Request request)

Returns the URL to the Service. The URL can be of 2 kinds:

• A relative URL Ex. ParmImp?PAservicepath=/master/getQuote.
• An absolute URL. Ex. http://www.oracle.com/new.html

NB. A service in this context can be an external link.

Parameters:

request - the Request

Returns:

a string which point to the service.

getUserOwner

public User getUserOwner()

Returns:

the owner of this service or null if none

getVirtualURL

public java.lang.String getVirtualURL()

Gets the virtual URL for this module.

Returns:

String the virtual URL for this module.

invoke

public void invoke(ServiceContext context)
            throws java.lang.Exception

Invokes a Service.

Parameters:

context - the ServiceContext.

Throws:

java.lang.Exception - when any error occurs.

isRedirectHelp

public boolean isRedirectHelp()

isSessionless

public boolean isSessionless()

Is the service sessionless?

Returns:

true if the service is session less

isValid

public boolean isValid()

Returns:

true If this Service is valid.

isViewCustomizable

public boolean isViewCustomizable()

Gets the view customizability status

Returns:

The view customizability status

isVisible

public boolean isVisible()

Returns:

true if this Service should be visible for the user.

removeAllDeviceGroups

public void removeAllDeviceGroups()

Remove all the device group assocations with the service.

removeAllGroups

public void removeAllGroups()

Remove the current service from all groups it is belongs to

See Also:

setGroups(oracle.panama.model.Group[])

setAdminURL

public void setAdminURL(java.lang.String url)

Sets the URL to the admin page for this module.

Parameters:

url - the URL to the admin page for this module.

setAreaId

public void setAreaId(long areaId)

Sets the areaId property (long) value.

Parameters:

areaId - The new value for the property.

See Also:

getAreaId()

setCategory

public void setCategory(int category)

Set the Folder category.

Parameters:

category - The Folder category

See Also:

getCategory()

setCost

public void setCost(int cost)

Set cost for the Service. Cost is in any customer specific unit, the Service does not use this attribute in any logic.

Parameters:

cost - the cost in any unit

setCustomizationPageURL

public void setCustomizationPageURL(java.lang.String url)

Sets the customization page url a Service.

Parameters:

url - the customization page url

setDescription

public void setDescription(java.lang.String description)

Parameters:

description - the description text.

setGroups

public void setGroups(Group[] groups)

Parameters:

groups - the list of groups the service belongs to

See Also:

getGroups()

setParent

public void setParent(Folder parent)

Move this service into a folder. A service can only exists in one folder at the time.

Parameters:

parent - the Folder to put this service into, a null folder is equals to the root folder (no parent).

setPrimaryAudio

public void setPrimaryAudio(java.lang.String primaryAudio)

Sets the primary audio property (String) value.

setPrimaryImage

public void setPrimaryImage(java.lang.String primaryImage)

Sets the primary image property (String) value.

setRedirectHelp

public void setRedirectHelp(boolean redirectHelp)

setSecondaryAudio

public void setSecondaryAudio(java.lang.String secondaryAudio)

Sets the secondary audio property (String) value.

setSecondaryImage

public void setSecondaryImage(java.lang.String secondaryImage)

Sets the secondary image property (String) value.

setSequenceNo

public void setSequenceNo(int sequenceNo)

Sets the sequence number for ordering.

Parameters:

sequenceNo - the sequence number.

setShortName

public void setShortName(java.lang.String shortName)

Sets the shortName for a Service. The shortName should be unique for a user. Used when invoked from a SMS.

Parameters:

shortName - The new shortName for this Service

setUserOwner

public void setUserOwner(User user)

Set the owner of this service.

Parameters:

user - the owner.

setValid

public void setValid(boolean valid)

Allow the administrator to set a service to valid or invalid.

Parameters:

valid - true if valid or false if not.

setViewCustomizable

public void setViewCustomizable(boolean value)

Sets the view customizability status

Parameters:

value - The view customizability status

setVirtualURL

public void setVirtualURL(java.lang.String url)

Sets the virtual URL for this module.

Parameters:

url - the virtual URL for this module.

setVisible

public void setVisible(boolean visible)

Allow the administrator to set the visibility of a service.

Parameters:

visible - true if visible otherwise false.