|
Class Name |
API Method |
SDK Version |
Package |
SDK Class Name |
SDK Method |
Notes/Usage |
|
ActionContext |
GetAISConnection |
[not exposed] |
N/A |
N/A |
N/A |
No need to provide access to connection object since SDK handles all
initializations. |
|
ActionContext |
GetBooleanParameter |
7.5 |
java.util |
Map |
get |
The WS auto action parameters are provided to the auto action via a
Map object. Values are stored as strings, and the developer must convert them
as desired. |
|
ActionContext |
GetIntegerParameter |
7.5 |
java.util |
Map |
get |
The WS auto action parameters are provided to the auto action via a
Map object. Values are stored as strings, and the developer must convert them
as desired. |
|
ActionContext |
getObjectManager |
7.5 |
com.idiominc.wssdk |
WSContext |
(depends on which manager is needed) |
|
|
ActionContext |
getParameter |
7.5 |
java.util |
Map |
get |
The WS auto action parameters are provided to the auto action via a
Map object. Values are stored as strings, and the developer must convert them
as desired. |
|
ActionContext |
getServiceLocator |
7.5 |
com.idiominc.wssdk |
WSContext |
(depends on which manager is needed) |
|
|
ActionContext |
getWSContext |
7.5 |
com.idiominc.wssdk |
WSContext |
WSContext supplied by run services. Passed into execute method of
automatic actions. |
|
|
ActionContext |
log |
7.5 |
N/A |
N/A |
N/A |
Error message of thrown exception is logged as an error
automatically. |
|
ActionContext |
logError |
7.5 |
N/A |
N/A |
N/A |
Error message of thrown exception is logged as an error
automatically. |
|
AIS |
getNode |
6.5 |
N/A |
N/A |
N/A |
|
|
AISConnection |
copy |
7 |
com.idiominc.wssdk.ais |
WSAisManager |
copy |
|
|
AISConnection |
createRecurse |
7.5 |
com.idiominc.wssdk.ais |
WSAisManager |
create |
Creates a new node based on an existing node. |
|
AISConnection |
exists |
6.5 |
com.idiominc.wssdk.ais |
WSAisManager |
getNode() !=null |
If the node does not exist, null is returned. |
|
AISConnection |
getNode |
6.5 |
com.idiominc.wssdk.ais |
WSAisManager |
getNode |
|
|
AISConnection |
getPossibleTypes |
6.5 |
com.idiominc.wssdk.ais |
WSNodeType |
[constants] |
|
|
AISConnection |
|
[not exposed] |
N/A |
N/A |
N/A |
No need to provide access to connection object since SDK handles all
initializations. |
|
AISProperty |
getWSOBjectValue |
7.5 |
com.idiominc.wssdk.ais |
WSMetaDataNode |
getPropertyObject |
|
|
AutomaticActionUtils |
getMount |
7.5 |
com.idiominc.wssdk.ais |
WSMountManager |
getMount |
|
|
ConnectionLease |
getLease |
[not exposed] |
N/A |
N/A |
N/A |
This method is not needed in the SDK. |
|
ConnectionManager |
get |
[not exposed] |
N/A |
N/A |
N/A |
This method is not needed in the SDK. |
|
ConnectionManager |
release |
[not exposed] |
N/A |
N/A |
N/A |
This method is not needed in the SDK. |
|
EmbeddableCode |
getId |
6.5 |
com.idiominc.wssdk.asset |
WSTextSegmentPlaceholder |
getId |
|
|
FilesystemNodeImp |
getFile |
7 |
com.idiominc.wssdk.ais |
WSNode |
getFile |
|
|
Hit |
getScore |
6.5 |
com.idiominc.wssdk.tm |
WSTmHit |
getSource |
|
|
Hit |
getTarget |
6.5 |
com.idiominc.wssdk.tm |
WSTmHit |
getTarget |
|
|
Hit |
getTmTranslation |
6.5 |
com.idiominc.wssdk.tm |
WSTmHit |
getTmEntry |
|
|
Link |
getEnabled |
7 |
com.idiominc.wssdk.linkage |
WSLink |
isEnabled |
|
|
Login |
login |
6.5 |
com.idiominc.wssdk |
WSContextManager |
runAsUser |
|
|
Login |
loginAsSuperuser |
[not exposed] |
N/A |
N/A |
N/A |
Running as super user not externally supported. runAsUser will
provide necessary support. |
|
LookupAssetSegments |
lookupSegment |
6.5 |
com.idiominc.wssdk.tm |
WSTm WSTmGroup |
lookup |
|
|
NamedWorkflow |
getWorkflow |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
getWorkflow |
|
|
Node |
getAISProperty |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getProperty |
|
|
Node |
getChildNodes |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getChildren getAllChildren |
|
|
Node |
getChildren |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getChildren getAllChildren |
|
|
Node |
getContent |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
isContent & getInputStream |
|
|
Node |
getEncoding |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getEncoding |
|
|
Node |
getInputStream |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getInputStream |
|
|
Node |
getLastModified |
7 |
com.idiominc.wssdk.ais |
WSNode |
getLastModifiedDate |
|
|
Node |
getMediaType |
7 |
com.idiominc.wssdk.ais |
WSMimeTypeManager |
getMimeType |
MediaType replaced with WSMimeType in SDK, |
|
Node |
getNodeImp |
6.5 |
com.idiominc.wssdk.ais |
WSAisManager |
getNode |
|
|
Node |
getOutputStream |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getOutputStream |
|
|
Node |
getPath |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getPath |
|
|
Node |
getProperty |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getProperty |
|
|
Node |
getReader |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getReader |
|
|
Node |
getWriter |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
getWriter |
|
|
Node |
getWSObjectProperty |
7.5 |
com.idiominc.wssdk.ais |
WSMetaDataNode |
getPropertyObject |
|
|
Node |
isContainer |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
isContainer |
|
|
Node |
isContent |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
isContent |
|
|
Node |
isText |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
isText |
|
|
Node |
setContent |
7 |
com.idiominc.wssdk.ais |
WSNode |
getWriter |
The user can set the content using the writer object |
|
Node |
setProperty |
6.5 |
com.idiominc.wssdk.ais |
WSNode |
setProperty |
|
|
NodeImp |
getFile |
7 |
com.idiominc.wssdk.ais |
WSNode |
getFile |
|
|
ObjectManager |
flush |
[not exposed] |
N/A |
N/A |
N/A |
Flushing of changes to database is handled automatically. |
|
ObjectManager |
getAISMount |
7.5 |
com.idiominc.wssdk.ais |
WSMountManager |
getMount |
|
|
ObjectManager |
getLinks |
7 |
com.idiominc.wssdk.linkage |
WSLinkManager |
getAllLinks |
|
|
ObjectManager |
getProjectForWSLocale |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
getProjectForWSLocale |
|
|
ObjectManager |
getProjects |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
getProjects |
|
|
ObjectManager |
getProjectsForWSLocale |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
getProjectForWSLocale |
|
|
ObjectManager |
getStorageManager |
6.5 |
com.idiominc.wssdk |
WSContext |
(depends on which manager is needed) |
All managers are available via the supplied WSContext object. StorageManager
support not explicitly required. |
|
ObjectManager |
getWorkgroup |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
getWorkflow |
|
|
ObjectManager |
getWSLocale |
6.5 |
com.idiominc.wssdk.user |
WSUserManager |
getLocale |
|
|
OtherMount |
getConfig |
7.5 |
com.idiominc.wssdk.ais |
WSCustomMount |
getConfig |
|
|
PageContext |
getAISConnection |
[not exposed] |
N/A |
N/A |
N/A |
No need to provide access to connection object since SDK handles all
initializations. |
|
PageContext |
getIntegerParameter |
7 |
javax.servlet.http |
HttpServletRequest |
getParameter |
Standard Java structures used. User must convert parameters as
necessary. |
|
PageContext |
getParameter |
7 |
javax.servlet.http |
HttpServletRequest |
getParameter |
Standard Java structures used. User must convert parameters as
necessary. |
|
PageContext |
getRequest |
7 |
javax.servlet.http |
HttpServletRequest |
getParameter |
Standard Java structures used. User must convert parameters as
necessary. |
|
PageContext |
getResponse |
7 |
javax.servlet.http |
HttpServletResponse |
getResponse |
Standard Java structures used. User must convert parameters as
necessary. |
|
PageContext |
getServletContext |
[not exposed] |
N/A |
N/A |
N/A |
Servlet is provided a handle to the WSContext directly. |
|
PageContext |
getString |
7 |
javax.servlet.http |
HttpServletRequest |
getParameter |
Standard Java structures used. User must convert parameters as
necessary. |
|
PageContext |
getUser |
7 |
com.idiominc.wssdk |
WSContext |
getUser |
|
|
PageContext |
getWSContext |
[not exposed] |
N/A |
N/A |
N/A |
Servlet is provided a handle to the WSContext directly. |
|
Project |
getCreationDate |
7.5 |
com.idiominc.wssdk.workflow |
WSProject |
getCreationDate |
|
|
Project |
getDueDate |
7.5 |
com.idiominc.wssdk.workflow |
WSProject |
getDueDate |
|
|
Project |
getId |
7.5 |
com.idiominc.wssdk.workflow |
WSProject |
getId |
|
|
Project |
getName |
7.5 |
com.idiominc.wssdk.workflow |
WSProject |
getName |
|
|
Project |
getWSLocale |
7.5 |
com.idiominc.wssdk.workflow |
WSProject |
getLocale |
|
|
Project |
length |
7.5 |
com.idiominc.wssdk.workflow |
WSProject |
getDuration |
|
|
Project |
setCreateDate |
[not exposed] |
N/A |
N/A |
N/A |
Creation date is handled internally. |
|
Project |
setDescription |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
createProjectGroup |
Description is set for the project group at creation time. This
represents the description for all contained projects. |
|
Project |
setName |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
createProjectGroup |
Name is set at project group creation, and shared for all contained
projects. |
|
Project |
setWorkgroup |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
createProjectGroup |
Values assigned at project group creation. |
|
Project |
setWSLocale |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
createProjectGroup |
Values assigned at project group creation. |
|
ProjectCreator |
createProject |
7.5 |
com.idiominc.wssdk.workflow |
WSProjectGroup |
createProject |
|
|
ProjectCreator |
setAssets |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
createProjectGroup |
Values assigned at project group creation. |
|
ProjectGroup |
[unknown] |
7.5 |
com.idiominc.wssdk.workflow |
WSProjectGroup |
|
|
|
ProjectManager |
getActiveProjectsForWSLocale |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowManager |
getProjectsForLocale |
Provide the active status to filter for active projects. |
|
ScopeAnalyzer |
finish |
6.5 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
getScope |
Finish method added scope information to segmented asset. This does
not need to be called in the SDK. Simply get the WSAssetTranslationScope
object. |
|
Segment |
getSegmentedDocId |
6.5 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
getId |
|
|
Segment |
getText |
7 |
com.idiominc.wssdk.asset |
WSSegment WSTextSegment |
getContent |
|
|
SegmentedAsset |
getSegmentedAsset |
6.5 |
com.idiominc.wssdk.asset |
WSAssetManager |
getAssetTranslation |
|
|
SegmentedAsset |
getSegments |
6.5 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
segmentIterator or textsegmentIterator |
|
|
SegmentedAsset |
getSrcLanguage |
6.5 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
getSourceLanguage |
|
|
SegmentedAsset |
getTgtLanguage |
6.5 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
getTargetLanguage |
|
|
SegmentedAsset |
getTMDatabase |
7 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
getTm |
|
|
SegmentedAsset |
getTMGroup |
7 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
getTm |
TMs and TM Groups are used interchangeably. User must type check to
see if the returned values is actually a TM group. |
|
SegmentedAsset |
saveToAIS(WSContext, boolean) |
7 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
saveTranslationToAis |
The boolean option in core not currently supported. Need to
investigate requirement. |
|
SegmentedAsset |
setSrcFingerprint |
7 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
clearCache |
Setting the fingerprint is not supported, but the cache can be
cleared to force the document to be resegmented the next time it is
retrieved. |
|
SegmentedAsset |
updateSegment |
7 |
N/A |
N/A |
N/A |
In the SDK, this is done automatically whenever a segment is
changed. |
|
SegmentedAsset |
updateTM |
6.5 |
com.idiominc.wssdk.asset |
WSAssetTranslation |
saveTranslationToTm |
|
|
SegmentedAssetUtils |
get |
6.5 |
com.idiominc.wssdk.asset |
WSAssetManager |
getAssetTranslation |
|
|
SegmentedDocument |
getSrcPath |
6.5 |
com.idiominc.wssdk.asset |
WSAssetTranslation WSNode |
getSourceAisNode getPath |
|
|
SegmentedDocument |
getTgtPath |
6.5 |
com.idiominc.wssdk.asset |
WSAssetTranslation WSNode |
getTargetAisNode getPath |
|
|
ServiceLocator |
getProjectManager |
7.5 |
com.idiominc.wssdk |
WSContext |
getWorkflowManager |
|
|
ServiceLocator |
getTdManager |
6.5 |
com.idiominc.wssdk.tm |
WSContext |
getTdManager |
|
|
ServiceLocator |
getTmManager |
6.5 |
com.idiominc.wssdk.tm |
WSContext |
getTmManager |
|
|
Status |
is(String) |
7 |
com.idiominc.wssdk.asset |
WSTextSegmentTranslation |
isExactTranslated isFuzzyTranslated isHumanTranslated
isICETranslated isNotTranslated isTmTranslated |
|
|
StorageManager |
flush |
[not exposed] |
N/A |
N/A |
N/A |
Automatically performed in SDK. |
|
Task |
getClaimant |
7.5 |
com.idiominc.wssdk.workflow |
WSTaskStep |
getCurrentClaimant |
|
|
Task |
getProject |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
getProject |
|
|
Task |
getSegmentedAsset |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
getAssetTranslation |
|
|
Task |
getSourceAssets |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
getSourceAsset |
|
|
Task |
getStatus |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
getStatus |
|
|
Task |
getTargetAssets |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
getTargetAsset |
|
|
Task |
getTaskNumInProject |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
getTaskNumberInProject |
|
|
Task |
isCompleted |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
getStatus() == WSTask.STATUS_COMPLETED |
Use getStatus and state constant |
|
Task |
setProject |
7.5 |
com.idiominc.wssdk.workflow |
WSProject |
addTask |
Setting the project for a task must be done through the target
project object. |
|
TaskHistoryEntry |
TASK_CANCELED |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
STATUS_CANCELED |
|
|
TaskStep |
getWorkflowStep |
7.5 |
com.idiominc.wssdk.workflow |
WSTaskStep |
getWorkflowStep |
|
|
TdManager |
getTdEntry |
6.5 |
com.idiominc.wssdk.tm |
WSTdManager |
getEntry |
|
|
TdManager |
getTdEntryTerms |
6.5 |
com.idiominc.wssdk.tm |
WSTdEntry |
getTerms |
|
|
TextSegment |
getCodes |
6.5 |
com.idiominc.wssdk.asset |
WSTextSegment |
getPlaceholders |
|
|
TextSegment |
getStatus |
6.5 |
com.idiominc.wssdk.asset |
WSTextSegmentTranslation |
isExactTranslated isFuzzyTranslated isHumanTranslated
isICETranslated isNotTranslated isTmTranslated |
|
|
TextSegment |
getTarget |
6.5 |
com.idiominc.wssdk.asset |
WSTextSegmentTranslation |
getTarget |
|
|
TextSegment |
getText |
6.5 |
com.idiominc.wssdk.asset |
WSTextSegmentTranslation |
getSource |
|
|
TextSegment |
setStatus |
6.5 |
com.idiominc.wssdk.asset |
WSTextSegmentTranslation |
setIsHumanTranslated |
All other status are controlled automatically. |
|
TextSegment |
setTarget |
6.5 |
com.idiominc.wssdk.asset |
WSTextSegmentTranslation |
setTarget |
|
|
TextSegment |
setText |
6.5 |
com.idiominc.wssdk.asset |
WSTextSegment |
setContent |
|
|
TmManager |
lookupAssetSegments |
6.5 |
com.idiominc.wssdk.tm |
WSTmManager |
getTM getTmGroup |
TMs and TM Groups provide look functionality within the TM. |
|
TmString |
[unknown] |
[not exposed] |
N/A |
N/A |
N/A |
TmStrings not needed in SDK |
|
Transaction |
commit |
[not exposed] |
N/A |
N/A |
N/A |
Transactions not explicitly supported. Controlled via the SDK run
services. See WSRunnable and WSContextManager documentation. |
|
Transaction |
rollback |
[not exposed] |
N/A |
N/A |
N/A |
Transactions not explicitly supported. Controlled via the SDK run
services. See WSRunnable and WSContextManager documentation. |
|
UIUtils |
getTargetLocales |
7 |
N/A |
N/A |
N/A |
This functionality can be accessed using the SDK, although there is
not a single method for doing this. See SDKUtils.java sample code for insight
on this. |
|
User |
getName |
6.5 |
com.idiominc.wssdk.user |
WSUser |
getFirstName getLastName getFullName |
|
|
User |
getUserType |
6.5 |
com.idiominc.wssdk.user |
WSUser |
getUserType |
|
|
Utils |
getTM |
6.5 |
com.idiominc.wssdk.tm |
WSTmManager |
getTM |
|
|
VersionedNode |
isCheckedOut |
7 |
com.idiominc.wssdk.ais |
WSVersionNode |
isCheckedOut |
|
|
VersionedNode |
versionCheckOut |
7 |
com.idiominc.wssdk.ais |
WSVersionNode |
checkOut |
|
|
WorkflowEngine |
cancelTask |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
cancel |
|
|
WorkflowEngine |
getCurrentTaskStep |
7.5 |
com.idiominc.wssdk.workflow |
WSTask |
getCurrentTaskStep |
|
|
WorkflowStep |
getType |
7.5 |
com.idiominc.wssdk.workflow |
WSWorkflowStep |
getType |
|
|
WSContext |
[unknown] |
6.5 |
N/A |
N/A |
N/A |
WSContext supplied by run services. See WSRunnable and
WSContextManager. |
|
WSContext |
getAISConnection |
6.5 |
N/A |
N/A |
N/A |
This call is not required in SDK. |
|
WSContext |
getObjectManager |
7.5 |
com.idiominc.wssdk |
WSContext |
(depends on desired manager) |
|
|
WSContext |
getServiceLocator |
[not exposed] |
N/A |
N/A |
N/A |
Service locator not required in SDK. See WSContext. |
|
WSContext |
getTargetAssets |
[not exposed] |
N/A |
N/A |
N/A |
While there is not a specific API for this, this can still be
achieved. See SDKUtils.getAssets method for insight. |
|
WSContext |
getWSContext |
6.5 |
N/A |
N/A |
N/A |
WSContext supplied by run services. See WSRunnable and
WSContextManager. |
|
WSContext |
getWSSession |
6.5 |
N/A |
N/A |
N/A |
Sessions are created internally within SDK. Not exposed. |
|
WsLocale |
getLanguageName |
6.5 |
com.idiominc.wssdk.linguistic |
WSLanguage |
getName |
Access the WSLanguage object via the WSLocale object. |
|
WSLocale from Node |
getAISProperty |
6.5 |
|
WSNode |
getProperty |
Use the WSNode object to access properties, not the WSLocale. |
|
WSRuntimeException |
[unknown] |
6.5 |
|
WSRuntimeException |
|
|
|
WSSession |
getUser |
6.5 |
com.idiominc.wssdk.user |
WSUserManager |
getUser |
WSSession not exposed in SDK. |