Package dm.soap.services.bcs.data

Class BcsKeywordInfo

java.lang.Object

dm.soap.services.DmSoapService

dm.soap.services.bcs.TechDocBcsService

dm.soap.services.bcs.data.BcsKeywordInfo

All Implemented Interfaces:

dm.soap.DmSoapConstants

public class BcsKeywordInfo
extends TechDocBcsService

This class holds all of the information about the keyword it's constructed with in a manner that will work with SharePoint BCS.

Field Summary

Fields inherited from class dm.soap.services.bcs.TechDocBcsService

_context

Fields inherited from class dm.soap.services.DmSoapService

GEN_TYPE_NATIVE, GEN_TYPE_RENDERED, GEN_TYPE_UNKNOWN

Fields inherited from interface dm.soap.DmSoapConstants

PROP_CURRENT_USER, TECHDOC_REASON

Constructor Summary

Constructors

Constructor	Description
BcsKeywordInfo()	Creates a new instance of BcsKeywordInfo.
BcsKeywordInfo(dm.record.Keyword key)	Creates a new instance of BcsKeywordInfo.

Method Summary

Modifier and Type	Method	Description
String	getDataType()	Returns the data type for this keyword.
String	getDescription()	Returns the description for this keyword.
String	getInputType()	Returns the input type for this keyword.
int	getKeywordID()	Returns the ID for this keyword.
String	getName()	Returns the name for this keyword.
boolean	getPrivateKeyword()	Returns whether or not this is a private keyword.
String	getValues()	Returns the values for this keyword.

Methods inherited from class dm.soap.services.bcs.TechDocBcsService

document_AssociateAccess, document_AssociateCommenters, document_AssociateDistribution, document_AssociateNotification, document_Create, document_CreateResidentDocument, document_Delete, document_DeleteComment, document_ExistsByDocNumber, document_ExistsByID, document_Fetch, document_GetGenerations, document_ReadItemByID, document_ReadList, document_Release, document_Replace, document_Reserve, document_ShowAssociations, document_Unrelease, document_Unreserve, document_Update, documentCategory_ReadItemByAbbreviation, documentCategory_ReadList, documentKeyword_Create, documentKeyword_Delete, documentKeyword_ReadItemById, documentKeyword_ReadList, documentKeyword_Update, documentReadAccess_ReadItemByName, documentReadAccess_ReadList, documentType_ReadItemByAbbreviation, documentType_ReadList, documentWebSearch_ReadItemByName, documentWebSearch_ReadList, encodeNameValueString, folder_AssociateAccess, folder_Create, folder_CreateFolderTree, folder_Delete, folder_ExistsByID, folder_ExistsByPath, folder_GetChildDocuments, folder_GetChildFolders, folder_MoveContents, folder_ReadItemById, folder_ReadList, folder_Update, folderReadAccess_ReadItemByName, folderReadAccess_ReadList, generation_CreateRendition, generation_Delete, generation_ExistsByGenNumber, generation_ExistsByID, generation_ReadItemByID, generation_ReadList, generation_ReplaceRendition, generation_ResubmitRendition, generation_Update, generation_UpdateReleaseDate, group_ReadItemByName, group_ReadList, keyword_ReadItemByName, keyword_ReadList, organization_ReadItemByAbbreviation, organization_ReadList, rmaFilePlan_ReadItemByName, rmaFilePlan_ReadList, user_ReadItemByUsername, user_ReadList

Methods inherited from class dm.soap.services.DmSoapService

allowRender, calculateAccessToRemove, getActiveSessions, getAuthenticator, getAuthenticator, getAuthenticatorID, getAuthenticatorServiceID, getBoolean, getBoolean, getBooleanValue, getBooleanValue, getCommentID, getCurrentUser, getDisabled, getDisabledValue, getDocCategory, getDocCatID, getDocComment, getDocCommentIDs, getDocID, getDocType, getDocTypeID, getDocument, getDocument, getDocumentAccess, getDocumentInheritanceTypeID, getEmployer, getEmployerID, getEmployerString, getFetchAccess, getFetchAccessID, getFile, getFolder, getFolder, getFolder, getFolderAccess, getFolderInheritanceTypeID, getFolderReadAccess, getFullFolderPath, getGeneration, getGeneration, getGeneration, getGenerationType, getGroup, getGroup, getGroupMemberType, getGroupType, getIntValue, getKeyword, getKeywordDataType, getKeywordDataTypeString, getKeywordID, getKeywordInputType, getKeywordInputTypeString, getKeywordString, getMetricFrequency, getMetricOrg, getMetricOrgID, getMetricPerson, getMetricPersonID, getMetricStatusID, getMetricType, getMimeType, getMimeTypeID, getMimeTypeName, getNetworkAddress, getNetworkAddressType, getNetworkAddressType, getOrg, getOrgID, getOrgString, getReadAccess, getReadAccessString, getReason, getRemoteUser, getRemoteUser, getReview, getReviewTeam, getReviewTeamID, getRmaFilePlanID, getRmaFilePlanString, getRmaRecordSetID, getRmaRecordSetString, getSmHost, getSmHostWebSearchID, getSmHostWebSearchString, getSmSendID, getSmSendString, getUser, getUserFullName, getUserID, getUsername, getUserPrivs, getUserPrivsString, getWebSearchID, getWebSearchString, parseGenerationNumber

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BcsKeywordInfo

public BcsKeywordInfo()

Creates a new instance of BcsKeywordInfo.

BcsKeywordInfo

public BcsKeywordInfo(dm.record.Keyword key)
               throws td.lang.TdException

Creates a new instance of BcsKeywordInfo.

Parameters:

key - The keyword to populate this object with.

Throws:

td.lang.TdException - if an error occurs.

Method Details

getDataType

public String getDataType()

Returns the data type for this keyword.

Returns:

A String object.

getDescription

public String getDescription()

Returns the description for this keyword.

Returns:

A String object.

getInputType

public String getInputType()

Returns the input type for this keyword.

Returns:

A String object.

getKeywordID

public int getKeywordID()

Returns the ID for this keyword.

Returns:

An int.

getName

public String getName()

Returns the name for this keyword.

Returns:

A String object.

getPrivateKeyword

public boolean getPrivateKeyword()

Returns whether or not this is a private keyword.

Returns:

True if this is a private keyword, false otherwise.

getValues

public String getValues()

Returns the values for this keyword.

Returns:

An encoded String object.