|
Oracle Application Server Wireless Java API Reference B10400-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 | |
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() |
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() |
oracle.panama.core.ServiceCategory[] |
getServiceCategories() |
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 |
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 owner) 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 |
public static final java.lang.String TYPENAME
public static final int TYPEID
public static final int CATEGORY_SERVICE
public static final int CATEGORY_MASTER
public static final int CATEGORY_USER_HOME
Method Detail |
public void setDescription(java.lang.String description)
description
- the description text.public java.lang.String getDescription()
public java.lang.String getURL()
public java.lang.String getURLPathParameter()
NB. A service in this context can be an external link.
public java.lang.String getURLPathParameter(Request request)
NB. A service in this context can be an external link.
request
- the Requestpublic int getSequenceNo()
public void setSequenceNo(int sequenceNo)
public boolean isVisible()
public void setVisible(boolean visible)
visible
- true if visible otherwise false.public boolean isValid()
public void setValid(boolean valid)
valid
- true if valid or false if not.public User getUserOwner()
public void setUserOwner(User owner)
public Folder getParent()
public void setParent(Folder parent)
public java.lang.String getShortName()
public void setShortName(java.lang.String shortName)
shortName
- The new shortName for this Servicepublic int getCost()
public void setCost(int cost)
cost
- the cost in any unitpublic long getAreaId()
setAreaId(long)
public void setAreaId(long areaId)
getAreaId()
public void invoke(ServiceContext context) throws java.lang.Exception
context
- the ServiceContext.java.lang.Exception
- when any error occurs.public Transformer getTransformer(Device device)
public void setViewCustomizable(boolean value)
value
- The view customizability statuspublic boolean isViewCustomizable()
public java.lang.String getPrimaryImage()
public void setPrimaryImage(java.lang.String primaryImage)
public java.lang.String getSecondaryImage()
public void setSecondaryImage(java.lang.String secondaryImage)
public java.lang.String getPrimaryAudio()
public void setPrimaryAudio(java.lang.String primaryAudio)
public java.lang.String getSecondaryAudio()
public void setSecondaryAudio(java.lang.String secondaryAudio)
public Group[] getGroups()
setGroups(oracle.panama.model.Group[])
public void setGroups(Group[] groups)
groups
- the list of groups the service belongs togetGroups()
public void removeAllGroups()
setGroups(oracle.panama.model.Group[])
public int getCategory()
setCategory(int)
public void setCategory(int category)
category
- The Folder categorygetCategory()
public Presets getPresets(PresetCategory category, java.lang.Long id)
public Presets getPresets(PresetCategory category, java.lang.String name)
public Presets createPresets(PresetCategory category)
public Presets createPresets(PresetCategory category, java.lang.String name)
public java.util.Vector getAllPresets(PresetCategory category)
public void deletePresets(PresetCategory category, java.lang.Long id)
public void deletePresets(PresetCategory category, java.lang.String name)
public boolean isRedirectHelp()
public void setRedirectHelp(boolean redirectHelp)
public java.lang.String getCustomizationPageURL()
public void setCustomizationPageURL(java.lang.String url)
url
- the customization page urlpublic java.lang.String getVirtualURL()
public void setVirtualURL(java.lang.String url)
url
- the virtual URL for this module.public java.lang.String getAdminURL()
public void setAdminURL(java.lang.String url)
url
- the URL to the admin page for this module.public oracle.panama.core.ServiceCategory[] getServiceCategories()
public ServiceAccessPoint[] getServiceAccessPoints()
public boolean isSessionless()
|
Oracle Application Server Wireless Java API Reference B10400-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |