|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.panama.portal.ServiceController
ServiceController handles service related operations, such as retrieving/updating parameters of a service, creating/deleting a service. ServiceController also handles Folder and Bookmark related operations, such as getting the children of a folder or modifying a Bookmark URL.
Field Summary | |
static java.lang.String |
BOOKMARKURL Key for retrieving bookmark url value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
CHILDRENORDER Key for retrieving service sequence value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
CONTAIN String constant represents containing condition. |
static java.lang.String |
EQUAL String constant represents equal to condition. |
static java.lang.String |
GREATER String constant represents greater than condition. |
static java.lang.String |
LESS String constant represents less than condition. |
static java.lang.String |
SERVICEFOLDER Key for retrieving service folder value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
SERVICENAME Key for retrieving service name value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
SORTRULE Key for retrieving sort rule value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
VIEWPROFILE Key for retrieving bookmark url value from the parameter Hashtable passing to/from the portal pages. |
static java.lang.String |
VISIBLE Key for retrieving bookmark url value from the parameter Hashtable passing to/from the portal pages. |
Method Summary | |
Link |
copyService(java.lang.String name, long serviceId, java.lang.String folderIdString, Request apiRequest) copy a service. |
Link |
copyService(java.lang.String name, long serviceId, java.lang.String folderIdString, java.lang.String profileName, boolean isVisibleVal, Request apiRequest) copy a service. |
ExternalLink |
createNewBookmark(java.lang.String name, java.lang.String url, java.lang.String folderIdString, Request apiRequest) create a new bookmark. |
ExternalLink |
createNewBookmark(java.lang.String name, java.lang.String url, java.lang.String folderIdString, java.lang.String profileName, boolean isVisibleVal, Request apiRequest) create a new bookmark. |
Folder |
createNewFolder(java.lang.String name, java.lang.String folderIdString, Request apiRequest) create a new folder. |
Folder |
createNewFolder(java.lang.String name, java.lang.String folderIdString, java.lang.String profileName, boolean isVisibleVal, Request apiRequest) create a new folder. |
void |
deleteService(long serviceId) delete a service. |
Link |
deployServiceToGroup(long serviceId, java.lang.String groupName, java.lang.String newServiceName, java.lang.String folderIdString, Request apiRequest) deploy a service to a group in certain folder |
Link |
deployServiceToUser(long serviceId, java.lang.String userName, java.lang.String newServiceName, java.lang.String folderIdString, Request apiRequest) deploy a service to a user in certain folder |
int |
getAccessCount(long serviceId, java.lang.String profileName, Request apiRequest) Get the access count of the service |
int[] |
getAllSortRules(Request apiRequest) get all of the index values of the SortRules |
Service[] |
getChildren(long folderId, Request apiRequest) Get children array of a folder. |
Service |
getCurrentService(Request apiRequest) get the current requested service. |
java.lang.String |
getExternalURL(long bookmarkId) Get the external URL String of a Bookmark. |
java.util.Hashtable |
getInputArguments(long serviceId) get input argument name-value Hashtable of a MasterService, Service, Alert. |
InputArgument[] |
getInputArgumentsArray(long serviceId) get input arguments array of a MasterService, Service, Alert. |
java.util.Date |
getLastAccessDate(long serviceId, java.lang.String profileName, Request apiRequest) Get the last accessed date of the service |
java.util.Hashtable |
getOutputArguments(long serviceId) get output argument name-(operation, value) Hashtable of a MasterService, Service, Alert. |
OutputArgument[] |
getOutputArgumentsArray(long serviceId) get output argument array of a MasterService, Service, Alert. |
Service[] |
getRootServices(Request apiRequest) get all the root services, folders and bookmarks |
int |
getSequenceNo(long serviceId, java.lang.String profileName, Request apiRequest) Get the sequence number of the service |
static ServiceController |
getServiceInstance() The singleton thread-safe getter. |
Service[] |
getServicePathNodes(Request apiRequest, Service service) |
Service[] |
getSortedChildren(long folderId, SortRule sortRule, java.lang.String profileName, Request apiRequest) Get the sorted childres services of the folder |
SortRule |
getSortRule(long folderId, java.lang.String profileName, Request apiRequest) get the SortRule for a Folder |
java.lang.String |
getSortRuleHeader(SortRule sortRuleObj) Get the header string for the given sortRule Object |
java.lang.String[] |
getSortRuleHeaders() Get all of the header strings for the sortRules |
java.lang.String |
getSortRuleName(SortRule sortRuleObj) Get the name for the given sortRule Object |
Service |
getURLMasterService(Request apiRequest) get the URLMasterService from repository |
boolean |
isBookmark(long objectId) check to see whether the object is a Bookmark. |
boolean |
isFolder(long objectId) check to see whether the object is a folder. |
boolean |
isPresetable(long serviceId) check if a Service is presetable |
boolean |
isQuicklink(long serviceId, java.lang.String name) check if a Service Node is a Quicklinked Service |
boolean |
isVisible(long serviceId, java.lang.String profileName, Request apiRequest) check if a Service is visible in the view profile |
void |
setInputArguments(long serviceId, java.util.Hashtable arguments) set input argument values of a MasterService, Service, Alert. |
void |
setOutputArguments(long serviceId, java.util.Hashtable arguments) set output argument filters of a MasterService, Service, Alert. |
void |
setParameters(long serviceId, java.util.Hashtable parameters, Request apiRequest) set parameter values of a service. |
void |
setSequenceNo(long serviceId, int seqNo, java.lang.String profileName, Request apiRequest) Set the sequence number of the service |
void |
setVisibilityHash(java.util.Hashtable visibilityValueHash) set visibility of multiple services. |
void |
setVisibilityHash(Profile viewProfile, java.util.Hashtable visibilityValueHash) set visibility of multiple services for the specified user's view profile. |
void |
switchFolderState(Request apiRequest, long folderId) |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String BOOKMARKURL
public static final java.lang.String CHILDRENORDER
public static final java.lang.String CONTAIN
public static final java.lang.String EQUAL
public static final java.lang.String GREATER
public static final java.lang.String LESS
public static final java.lang.String SERVICEFOLDER
public static final java.lang.String SERVICENAME
public static final java.lang.String SORTRULE
public static final java.lang.String VIEWPROFILE
public static final java.lang.String VISIBLE
Method Detail |
public Link copyService(java.lang.String name, long serviceId, java.lang.String folderIdString, Request apiRequest) throws PortalException
name
- new service name.folderIdString
- the containing folder id string.apiRequest
- current validated Request.PortalException
public Link copyService(java.lang.String name, long serviceId, java.lang.String folderIdString, java.lang.String profileName, boolean isVisibleVal, Request apiRequest) throws PortalException
name
- new service name.folderIdString
- the containing folder id string.profileName
- the current user's view profile.isVisibleVal
- the visibility value of the new service.apiRequest
- current validated Request.PortalException
public ExternalLink createNewBookmark(java.lang.String name, java.lang.String url, java.lang.String folderIdString, Request apiRequest) throws PortalException
name
- new bookmark name.url
- the url string of the new bookmark.folderIdString
- the containing folder id string.apiRequest
- current validated Request.PortalException
public ExternalLink createNewBookmark(java.lang.String name, java.lang.String url, java.lang.String folderIdString, java.lang.String profileName, boolean isVisibleVal, Request apiRequest) throws PortalException
name
- new bookmark name.url
- the url string of the new bookmark.folderIdString
- the containing folder id string.profileName
- the current user's view profile.isVisibleVal
- the visibility value of the new service.apiRequest
- current validated Request.PortalException
public Folder createNewFolder(java.lang.String name, java.lang.String folderIdString, Request apiRequest) throws PortalException
name
- new folder name.folderIdString
- the containing folder id string.apiRequest
- current validated Request.PortalException
public Folder createNewFolder(java.lang.String name, java.lang.String folderIdString, java.lang.String profileName, boolean isVisibleVal, Request apiRequest) throws PortalException
name
- new folder name.folderIdString
- the containing folder id string.profileName
- the current user's view profile.isVisibleVal
- the visibility value of the new service.apiRequest
- current validated Request.PortalException
public void deleteService(long serviceId) throws PortalException
serviceId
- deleted service ID.PortalException
public Link deployServiceToGroup(long serviceId, java.lang.String groupName, java.lang.String newServiceName, java.lang.String folderIdString, Request apiRequest) throws PortalException
groupName
- the group name to deploy tonewServiceName
- the new name for the deployed servicefolderIdString
- the folder to deployed toapiRequest
- current validated Request.PortalException
public Link deployServiceToUser(long serviceId, java.lang.String userName, java.lang.String newServiceName, java.lang.String folderIdString, Request apiRequest) throws PortalException
userName
- the user name to deploy tonewServiceName
- the new name for the deployed servicefolderIdString
- the folder to deployed toapiRequest
- current validated Request.PortalException
public int getAccessCount(long serviceId, java.lang.String profileName, Request apiRequest) throws PortalException
serviceId
- the queried service idprofileName
- the user's view profile nameapiRequest
- current validated Request.PortalException
public int[] getAllSortRules(Request apiRequest) throws PortalException
apiRequest
- current validated Request.PortalException
public Service[] getChildren(long folderId, Request apiRequest) throws PortalException
folderId
- queried folder ID.apiRequest
- current validate Request.PortalException
public Service getCurrentService(Request apiRequest)
apiRequest
- current validated Request.public java.lang.String getExternalURL(long bookmarkId) throws PortalException
bookmarkId
- the queried Bookmark ID.PortalException
public java.util.Hashtable getInputArguments(long serviceId) throws PortalException
serviceId
- queried service ID.PortalException
public InputArgument[] getInputArgumentsArray(long serviceId) throws PortalException
serviceId
- queried service ID.PortalException
public java.util.Date getLastAccessDate(long serviceId, java.lang.String profileName, Request apiRequest) throws PortalException
serviceId
- the queried service idprofileName
- the user's view profile nameapiRequest
- current validated Request.PortalException
public java.util.Hashtable getOutputArguments(long serviceId) throws PortalException
serviceId
- queried service ID.PortalException
public OutputArgument[] getOutputArgumentsArray(long serviceId) throws PortalException
serviceId
- queried service ID.PortalException
public Service[] getRootServices(Request apiRequest) throws PortalException
apiRequest
- current validated requestPortalException
public int getSequenceNo(long serviceId, java.lang.String profileName, Request apiRequest) throws PortalException
serviceId
- the queried service idprofileName
- the user's view profile nameapiRequest
- current validated Request.PortalException
public static ServiceController getServiceInstance()
public Service[] getServicePathNodes(Request apiRequest, Service service)
public Service[] getSortedChildren(long folderId, SortRule sortRule, java.lang.String profileName, Request apiRequest) throws PortalException
folderId
- the queried folder idsortRule
- sort the children with this sort ruleprofileName
- the user's view profile nameapiRequest
- current validated Request.PortalException
public SortRule getSortRule(long folderId, java.lang.String profileName, Request apiRequest) throws PortalException
folderId
- queried folder ID.profileName
- queried user view profile name.apiRequest
- current validated Request.PortalException
public java.lang.String getSortRuleHeader(SortRule sortRuleObj)
sortRuleObj
- sortRule Objectpublic java.lang.String[] getSortRuleHeaders()
public java.lang.String getSortRuleName(SortRule sortRuleObj)
sortRuleObj
- sortRule Objectpublic Service getURLMasterService(Request apiRequest) throws PortalException
apiRequest
- current validated Request.PortalException
public boolean isBookmark(long objectId)
objectId
- queried object ID.public boolean isFolder(long objectId)
objectId
- queried object ID.public boolean isPresetable(long serviceId)
serviceId
- queried service ID.public boolean isQuicklink(long serviceId, java.lang.String name)
serviceId
- queried service ID.name
- service namepublic boolean isVisible(long serviceId, java.lang.String profileName, Request apiRequest) throws PortalException
serviceId
- queried service ID.profileName
- queried user's view profile name.apiRequest
- current validated request.PortalException
public void setInputArguments(long serviceId, java.util.Hashtable arguments) throws PortalException
arguments
- argument name-value Hashtable to updatePortalException
public void setOutputArguments(long serviceId, java.util.Hashtable arguments) throws PortalException
arguments
- argument name-(operation-value) Hashtable to update. Each (operation, value) object is also a Hashtable of operation-value filters.PortalException
public void setParameters(long serviceId, java.util.Hashtable parameters, Request apiRequest) throws PortalException
serviceId
- queried service ID.parameters
- parameter name-value Hashtable to updatePortalException
public void setSequenceNo(long serviceId, int seqNo, java.lang.String profileName, Request apiRequest) throws PortalException
serviceId
- the queried service idseqNo
- the sequence numberprofileName
- the user's view profile nameapiRequest
- current validated Request.PortalException
public void setVisibilityHash(java.util.Hashtable visibilityValueHash) throws PortalException
visibilityValueHash
- -- String-Boolean value pairs, for each one, String value is the service id, while Boolean value is the true/false value for visibilityPortalException
public void setVisibilityHash(Profile viewProfile, java.util.Hashtable visibilityValueHash) throws PortalException
viewProfile
- user's view profile objectvisibilityValueHash
- -- String-Boolean value pairs, for each one, String value is the service id, while Boolean value is the true/false value for visibilityPortalException
public void switchFolderState(Request apiRequest, long folderId) throws PortalException
PortalException
|
Oracle Application Server Wireless Java API Reference B14043-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |