Package dm.soap.services.bcs.data

Class BcsDocumentKeywordInfo

java.lang.Object

dm.soap.services.DmSoapService

dm.soap.services.bcs.TechDocBcsService

dm.soap.services.bcs.data.BcsDocumentKeywordInfo

All Implemented Interfaces:

dm.soap.DmSoapConstants

public class BcsDocumentKeywordInfo
extends TechDocBcsService

This class holds all of the information about about a document keyword. Typically we would just return a keyword name and value in normal SOAP but we need in ID driven mechanism for 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
BcsDocumentKeywordInfo(int docID, java.lang.String docKeywordID, java.lang.String docNumber, java.lang.String keywordName, java.lang.String keywordValue)	Creates a new instance of BcsDocumentKeywordInfo.
BcsDocumentKeywordInfo(dm.record.PartialDocumentView document, dm.record.Keyword keyword, dm.record.DocumentKeyword documentKeyword)	Creates a new instance of BcsDocumentKeywordInfo.

Method Summary

Modifier and Type	Method	Description
int	getDocID()	Returns the ID for the document.
java.lang.String	getDocKeywordID()	Returns the ID for this document keyword.
java.lang.String	getDocNumber()	Returns the number for the document.
java.lang.String	getKeywordName()	Returns the name for this document keyword.
java.lang.String	getKeywordValue()	Returns the values for this document 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 Detail

BcsDocumentKeywordInfo

public BcsDocumentKeywordInfo(int docID,
                              java.lang.String docKeywordID,
                              java.lang.String docNumber,
                              java.lang.String keywordName,
                              java.lang.String keywordValue)

Creates a new instance of BcsDocumentKeywordInfo.

Parameters:

docID - The document ID.

docKeywordID - The virtual/calculated document keyword ID.

docNumber - The document number.

keywordName - The name of the keyword.

keywordValue - The value of the keyword.

BcsDocumentKeywordInfo

public BcsDocumentKeywordInfo(dm.record.PartialDocumentView document,
                              dm.record.Keyword keyword,
                              dm.record.DocumentKeyword documentKeyword)

Creates a new instance of BcsDocumentKeywordInfo.

Parameters:

document - The document.

keyword - The keyword.

documentKeyword - The document keyword.

Method Detail

getDocID

public int getDocID()

Returns the ID for the document.

Returns:

An int.

getDocKeywordID

public java.lang.String getDocKeywordID()

Returns the ID for this document keyword.

Returns:

An string.

getDocNumber

public java.lang.String getDocNumber()

Returns the number for the document.

Returns:

A string.

getKeywordName

public java.lang.String getKeywordName()

Returns the name for this document keyword.

Returns:

A String object.

getKeywordValue

public java.lang.String getKeywordValue()

Returns the values for this document keyword.

Returns:

A String object.