FlashlineRegistrySoapBindingStub (Oracle© Fusion Middleware Extensibility Framework (REX) for Oracle Enterprise Repository)

Class

Tree

Help

Oracle© Fusion Middleware Extensibility Framework (REX) for Oracle Enterprise Repository
11g Release 1 (11.1.1)
E16598-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.flashline.registry.openapi.service.v300
Class FlashlineRegistrySoapBindingStub

java.lang.Object org.apache.axis.client.Stub com.flashline.registry.openapi.service.v300.FlashlineRegistrySoapBindingStub

All Implemented Interfaces:: FlashlineRegistry, java.rmi.Remote

public class FlashlineRegistrySoapBindingStub

extends org.apache.axis.client.Stub

implements FlashlineRegistry

Constructor Summary
`FlashlineRegistrySoapBindingStub()`
`FlashlineRegistrySoapBindingStub(javax.xml.rpc.Service service)`
`FlashlineRegistrySoapBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service)`

Method Summary
`AcceptableValueList`	`acceptableValueListCreate(AuthToken pAuthToken, java.lang.String pListName, AcceptableValue[] pValues)` Creates a new acceptable value list.
`AcceptableValueList[]`	`acceptableValueListQuery(AuthToken pAuthToken, AcceptableValueListCriteria pCriteria)` Searches for all acceptable value lists that contains the specified string (ignoring case)
`AcceptableValueList`	`acceptableValueListRead(AuthToken pAuthToken, long pId)` Read an acceptable value list.
`AcceptableValueList`	`acceptableValueListUpdate(AuthToken pAuthToken, AcceptableValueList pList)` Updates an acceptable value list, modifying both the name of the list and the acceptable values.
`ArtifactStoreBean[]`	`artifactStoreQuery(AuthToken pAuthTokenBean, ArtifactStoreCriteria pArtifactStoreCritera, boolean pCreateIfMissing)` Find an ArtifactStore that matches the criteria.
`void`	`assetAccept(AuthToken pAuthToken, long pID)` Accept an Asset.
`void`	`assetAcceptFiles(AuthToken pAuthToken, long pId, java.lang.String[] pFilenames)`
`void`	`assetActivate(AuthToken pAuthToken, long pAssetID)` Set an Asset's active-status to Active.
`void`	`assetAddRegistrarNote(AuthToken pAuthToken, long pId, java.lang.String pNotes)` Adds a registrar note to the log on the Administration tab
`void`	`assetApplyToProjects(AuthToken pAuthToken, java.lang.String[] pProjectIDs, Asset pAsset)` Apply templates to projects
`Asset`	`assetCreate(AuthToken pAuthToken, java.lang.String pName, java.lang.String pVersion, long pAssetTypeID)` Initial creation of a NEW asset.
`Asset`	`assetCreateFromXML(AuthToken pAuthToken, java.lang.String assetXML)` Initial creation of a NEW asset from an XML representation.
`void`	`assetDeactivate(AuthToken pAuthToken, long pAssetID)` Set an Asset's active-status to Inactive.
`void`	`assetDelete(AuthToken pAuthToken, long pAssetID)` Set an Asset's active-status to Deleted.
`KeyValuePair`	`assetEvaluate(AuthToken pAuthToken, AssetCriteria pCriteria, java.lang.String pEvaluationName)` Evaluate Asset attributes.
`java.lang.String`	`assetEvaluateAgainstAllPolicies(AuthToken pAuthToken, long pAssetID)` Evaluate an asset against all applied policies.
`java.lang.String`	`assetEvaluateAgainstPolicy(AuthToken pAuthToken, long pAssetID, long pPolicyID)` Evaluate an asset against a single applied policy.
`SubmissionFileInfo[]`	`assetGetUnacceptedFiles(AuthToken pAuthToken, long pId)`
`void`	`assetMetadataAccept(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)`
`void`	`assetMetadataCreateDIME(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)` Creates the metadata entry specified and associates it with the specified asset.
`void`	`assetMetadataCreateSwA(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)` Creates the metadata entry specified and associates it with the specified asset.
`void`	`assetMetadataEntryDelete(AuthToken pAuthToken, long pMetadataEntryID)` Deletes the specified metadata entry and disassociates it from its parent Asset.
`MetadataEntrySummary[]`	`assetMetadataRead(AuthToken pAuthToken, long pAssetID)` Reads metadata entries associated with the given Asset.
`MetadataEntrySummary[]`	`assetMetadataReadDIME(AuthToken pAuthToken, long pAssetID)` Reads metadata entries associated with the given Asset.
`MetadataEntrySummary[]`	`assetMetadataReadSwA(AuthToken pAuthToken, long pAssetID)` Reads metadata entries associated with the given Asset.
`void`	`assetMetadataUpdate(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)` Updates metadata entry specified.
`void`	`assetMetadataUpdateDIME(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)` Updates metadata entry specified.
`void`	`assetMetadataUpdateSwA(AuthToken pAuthToken, long pAssetID, MetadataEntrySummary pMetadataEntrySummary)` Updates metadata entry specified.
`Asset[]`	`assetQuery(AuthToken pAuthtoken, AssetCriteria pCriteria)` Search for Assets.
`int`	`assetQueryCount(AuthToken pAuthToken, AssetCriteria pCriteria)` Count the number of assets that would match a query on a specific criteria.
`AssetSummary[]`	`assetQuerySummary(AuthToken pAuthtoken, AssetCriteria pCriteria)` Search for Assets Summaries.
`Asset`	`assetRead(AuthToken pAuthToken, long pId)` Get an Asset object by Id.
`Asset[]`	`assetReadAppliedPolicies(AuthToken pAuthToken, long pAssetID)` Search for policies which are assigned to the specified asset
`Project[]`	`assetReadAppliedToProjects(AuthToken pAuthToken, Asset pAsset)` Search for projects which compliance template is applied to.
`Asset[]`	`assetReadArray(AuthToken pAuthToken, long[] pIds)` Get an array of Asset objects from an array of Ids.
`Asset[]`	`assetReadArrayFromSummary(AuthToken pAuthToken, AssetSummary[] pAssetSummaries)` Get an array of Asset objects from an array of AssetSummary objects.
`java.lang.String`	`assetReadCustomDataNode(AuthToken pAuthToken, long pId, java.lang.String pPath)` Get an Asset custom data node's XML by path
`java.lang.String`	`assetReadCustomDataString(AuthToken pAuthToken, long pId, java.lang.String pPath)` Get an Asset custom data node by path
`LogEntry[]`	`assetReadRegistrarNotes(AuthToken pAuthToken, long pId)` Reads the log of registrar notes
`java.lang.String`	`assetReadXml(AuthToken pAuthToken, long pId)` Retrieve the xml representation for an asset.
`void`	`assetRegister(AuthToken pAuthToken, long pID)` Registers an Asset.
`void`	`assetRemoveAppliedToProjects(AuthToken pAuthToken, java.lang.String[] pProjectIDs, Asset pAsset)` Removes templates from projects.
`void`	`assetRetire(AuthToken pAuthToken, long pAssetID)` Set an Asset's active-status to Retired.
`void`	`assetSubmit(AuthToken pAuthToken, long pID)` Submit an Asset.
`void`	`assetTabApprove(AuthToken pAuthTokenBean, long pAssetId, long pTabId)` Approve an asset's tab.
`TabBean`	`assetTabRead(AuthToken pAuthTokenBean, long pAssetId, long pTabTypeBeanId)` Read an asset's tab for a specific TabType.
`TabBean[]`	`assetTabsRead(AuthToken pAuthTokenBean, long pAssetId)` Retrieve all of the Tabs available for an asset.
`void`	`assetTabUnapprove(AuthToken pAuthTokeBean, long pAssetId, long pTabId)` Unapprove an asset's tab.
`AssetType`	`assetTypeCreate(AuthToken pAuthToken, java.lang.String pName)` Creates a new asset type that contains minimal metadata elements.
`AssetType`	`assetTypeCreateClone(AuthToken pAuthToken, long pBaseAssetTypeID, java.lang.String pName)` Creates a new asset type based on an existing asset type.
`AssetType`	`assetTypeCreateComplianceTemplate(AuthToken pAuthToken, java.lang.String pName)` Creates a new compliance template that contains minimal metadata elements.
`void`	`assetTypeDelete(AuthToken pAuthToken, long pId)` Deletes an existing asset type based on an ID.
`com.oracle.registry.openapi.entity.EntityArtifactRule[]`	`assetTypeGetEntityArtifactRules(AuthToken pAuthTokenBean, long pAssetTypeId)` Returns an array of EntityArtifactRule for the given Asset Type ID.
`AssetType[]`	`assetTypeQuery(AuthToken pAuthToken, AssetTypeCriteria pCriteria)` Searches for all asset types whose names contain the specified string (ignoring case)
`AssetType`	`assetTypeRead(AuthToken pAuthToken, long pId)` Creates a new compliance template that contains minimal metadata elements.
`java.lang.String`	`assetTypeSchemaRead(AuthToken pAuthToken, long pId)` Get the xml schema for an asset type.
`TabTypeBean[]`	`assetTypeTabsRead(AuthToken pAuthTokenBean, long pAssetTypeId)` Read an assettype's tabs.
`AssetType`	`assetTypeUpdate(AuthToken pAuthToken, AssetType pAssetType)` Updates an existing asset type.
`void`	`assetUnAccept(AuthToken pAuthToken, long pID)` Unaccept an Asset.
`void`	`assetUnRegister(AuthToken pAuthToken, long pID)` Unregister an Asset.
`void`	`assetUnSubmit(AuthToken pAuthToken, long pID)` Unsubmit an Asset.
`Asset`	`assetUpdate(AuthToken pAuthToken, Asset pAsset)` Updates an Asset, saving any modifications that were made to it.
`Asset`	`assetUpdateAppliedPolicies(AuthToken pAuthToken, long pAssetID, long[] pAppliedPolicies)` Specifies which policies are associated with this asset.
`Asset`	`assetUpdateCustomDataNode(AuthToken pAuthToken, long pAssetID, java.lang.String pPath, java.lang.String pValue)` Updates an Asset with a specified custom-data node modification.
`Asset`	`assetUpdateCustomDataNodeFromStringArray(AuthToken pAuthToken, long pAssetID, java.lang.String[] pPath, java.lang.String[] pValue)` Updates an Asset with a specified list of custom-data value modifications.
`Asset`	`assetUpdateCustomDataString(AuthToken pAuthToken, long pAssetID, java.lang.String pPath, java.lang.String pValue)` Updates an Asset with a specified custom-data value modification.
`Asset`	`assetUpdateCustomDataStringArray(AuthToken pAuthToken, long pAssetID, java.lang.String[] pPath, java.lang.String[] pValue)` Updates an Asset with a specified list of custom-data value modifications.
`void`	`assetUploadFiles(AuthToken pAuthToken, long pAssetID, java.lang.String[] pFilenames)` Upload files into the Flashline Registry UPLOAD repository.
`AuthToken`	`authTokenCreate(java.lang.String userName, java.lang.String credential)` Authenticates a user, creating an AuthToken that is used to prove who the user is.
`AuthToken`	`authTokenCreateWithLicense(java.lang.String userName, java.lang.String credential, java.lang.String license)` Authenticates a user, creating an AuthToken that is used to prove who the user is.
`void`	`authTokenDelete(AuthToken authToken)` Invalidates the OER authentication for a user.
`void`	`authTokenValidate(AuthToken authToken)` Tests the OER authentication token for a user.
`Categorization`	`categorizationChildCreate(AuthToken pAuthToken, java.lang.String pCategorizationName, CategorizationType pCategorizationType, Categorization pSuper)` Create a child categorization.
`Categorization[]`	`categorizationChildRead(AuthToken pAuthToken, CategorizationType pCategorizationType, Categorization pCategorization, boolean active)` Retrieve all child categorizations for a given categorization.
`Categorization`	`categorizationCreate(AuthToken pAuthToken, java.lang.String pCategorizationName, CategorizationType pCategorizationType)` Create a categorization
`Categorization`	`categorizationDeactivate(AuthToken pAuthToken, Categorization pCategorization, CategorizationType pCategorizationType)` Deactivate Categorization
`Categorization`	`categorizationReactivate(AuthToken pAuthToken, Categorization pCategorization, CategorizationType pCategorizationType)` Reactivate Categorization
`Categorization`	`categorizationRead(AuthToken pAuthToken, long pCategorizationID)` Retrieve categorization
`Categorization[]`	`categorizationReadByType(AuthToken pAuthToken, CategorizationType pCategorizationType, boolean active, boolean fullTree)` Retrieve all categorizations for a categorization types active set to true returns active categorizations fullTree set to true returns categories and their children
`CategorizationType`	`categorizationTypeCreate(AuthToken pAuthToken, java.lang.String pName, java.lang.String pSingularDisplay, java.lang.String pPluralDisplay, boolean pExclusiveAssign, boolean pProjectAssign)` Creates a categorization type
`void`	`categorizationTypeDelete(AuthToken pAuthToken, CategorizationType pCategorizationType)` Delete Categorization Type.
`CategorizationType[]`	`categorizationTypeQuery(AuthToken pAuthToken, CategorizationTypeCriteria pCriteria)` Retrieve categorization types for a given set of query criteria.
`CategorizationType`	`categorizationTypeRead(AuthToken pAuthToken, long pCategorizationTypeID)` Read categorization type.
`CategorizationType`	`categorizationTypeUpdate(AuthToken pAuthToken, CategorizationType pType)` This only updates the categorization Type, not all of the sub categorizations
`Categorization`	`categorizationUpdate(AuthToken pAuthToken, Categorization pCategorization, CategorizationType pCategorizationType)` Update a single categorization
`Categorization[]`	`categorizationUpdateArray(AuthToken pAuthToken, Categorization[] pCategorizations, CategorizationType pCategorizationType)` Update a list of categorizations within a categorization type.
`java.lang.String`	`configGetWebResourcePath()` Gets the Web server path to the location where Web resources are stored.
`Contact`	`contactCreate(AuthToken pAuthToken, java.lang.String pName)` Creates a new contact.
`void`	`contactDelete(AuthToken pAuthToken, long pID)` Deletes a contact.
`Contact[]`	`contactQuery(AuthToken pAuthToken, ContactCriteria pQuery)` Searches for all contacts whose names contain the specified criteria.
`Contact`	`contactRead(AuthToken pAuthToken, long pID)` Reads a contact by ID.
`Contact`	`contactUpdate(AuthToken pAuthToken, Contact pContact)` Updates a contact.
`protected org.apache.axis.client.Call`	`createCall()`
`java.lang.String[]`	`customAccessSettingDefaultNamesGet(AuthToken pAuthToken, java.lang.String pType)` Retrieve an array of the default custom access setting names of a particular type.
`java.lang.String[]`	`customAccessSettingNamesGet(AuthToken pAuthToken, java.lang.String pType)` Retrieve an array of existing cutom access setting names.
`java.lang.String[]`	`customAccessSettingTypesGet(AuthToken pAuthToken)` Retrieve an array of custom access setting types.
`Department`	`departmentCreate(AuthToken pAuthToken, java.lang.String pName, java.lang.String pDescription)` Creates a new Department.
`Department[]`	`departmentQuery(AuthToken pAuthToken, DepartmentCriteria pCriteria)` Search for a department.
`Department`	`departmentRead(AuthToken pAuthToken, java.lang.String pKey)` Gets a department by name.
`Department`	`departmentUpdate(AuthToken pAuthToken, Department pDepartment)` Update a department.
`void`	`exportCheckPermission(AuthToken pAuthToken)` Checks the permission level of the user represented by OER authentication credentials contained in pAuthToken to determine if they are allowed to perform an export.
`void`	`exportCleanup(AuthToken pAuthToken, ImpExpJob pJob)` Cleans up a COMPLETED, FAILED, or CANCELLED export job.
`ImpExpJob`	`exportExecute(AuthToken pAuthToken, java.lang.String pExportFormat, java.lang.String[] pExportFormatQualifiers, java.lang.String pDesc, java.lang.String pQueryFormat, java.lang.String pQuery)` Starts an export job running on the server.
`byte[]`	`exportGetAuditB64(AuthToken pAuthToken, ImpExpJob pJobBean, java.lang.String pAuditFormat)` Returns the Audit results of the export operation specified by pJobBean.
`void`	`exportGetAuditDIME(AuthToken pAuthToken, ImpExpJob pJobBean, java.lang.String pAuditFormat)` Returns the Audit results of the export operation specified by pJobBean.
`void`	`exportGetAuditSwA(AuthToken pAuthToken, ImpExpJob pJobBean, java.lang.String pAuditFormat)` Returns the Audit results of the export operation specified by pJobBean.
`AuditMsg`	`exportGetLatestAuditMsg(AuthToken pAuthToken, ImpExpJob pJobBean)` Returns the most recently added Audit message for the given export job.
`byte[]`	`exportGetResultsB64(AuthToken pAuthToken, ImpExpJob pJob)` Returns the results of the export operation (i.e., the "payload") specified by pJobBean.
`void`	`exportGetResultsDIME(AuthToken pAuthToken, ImpExpJob pJob)` Returns the results of the export operation (i.e., the "payload") specified by pJobBean.
`void`	`exportGetResultsSwA(AuthToken pAuthToken, ImpExpJob pJob)` Returns the results of the export operation (i.e., the "payload") specified by pJobBean.
`void`	`exportKill(AuthToken pAuthToken, ImpExpJob pJob)` Terminates a running export job.
`ImpExpJob[]`	`exportListJobs(AuthToken pAuthToken)` Returns a list of export jobs currently defined in the system.
`ImpExpJob`	`exportStatus(AuthToken pAuthToken, ImpExpJob pJob)` Retrieves an updated description of the current status of the export job.
`ExtractionDownload[]`	`extractionCreate(AuthToken pAuthToken, long pProjectId, long[] pAssetIDs)` Create Extraction
`ExtractionDownload[]`	`extractionCreateForUser(AuthToken pAuthToken, long pProjectID, long[] pAssetIDs, RegistryUser pRbacRegistrySecUserBean)` Create Extraction
`RegistryUser[]`	`extractionGetHiddenAssetUsers(AuthToken pAuthToken, long pProjectID)` Returns an array of users who can view assets consumed by a project that the owner of the AuthTokenBean cannot.
`Extraction`	`extractionRead(AuthToken pAuthToken, long pExtractionID)` Read Extraction
`Extraction[]`	`extractionReadAssetExtractions(AuthToken pAuthToken, long pProjectID, long pAssetID, boolean pActive)` Read Extractions
`Extraction`	`extractionReadByProjectAndAsset(AuthToken pAuthToken, long pProjectID, long pAssetID)` Read Extraction
`ExtractionDownload[]`	`extractionReadExtractionDownloads(AuthToken pAuthToken, Extraction pExtraction)` Read extractable files
`IExtraction`	`extractionReadExtractionStates(AuthToken pAuthToken)` Read Extraction States
`FileInfo[]`	`extractionReadFileInfos(AuthToken pAuthToken, Extraction pExtraction)` Read file info
`Extraction[]`	`extractionReadProjectExtractions(AuthToken pAuthToken, long pProjectID, boolean pActive)` Read Extractions
`Categorization[]`	`extractionReadRejectionReasons(AuthToken pAuthToken)` Read rejection reasons
`Asset[]`	`extractionReadRelatedAssets(AuthToken pAuthToken, long pAssetID)` Read related Assets
`Extraction[]`	`extractionReadUserExtractions(AuthToken pAuthToken, boolean pActive)` Read Extractions
`Extraction`	`extractionReject(AuthToken pAuthToken, Extraction pExtraction, Categorization pCategorization, java.lang.String pComments)` Reject an extraction.
`void`	`extractionResetDatabase()`
`Extraction`	`extractionStillEvaluating(AuthToken pAuthToken, Extraction pExtraction)` Update Extraction state
`Extraction`	`extractionTentativelyAccept(AuthToken pAuthToken, Extraction pExtraction)` Update Extraction state
`Extraction`	`extractionUpdateSurvey(AuthToken pAuthToken, Extraction pExtraction, SurveyTaken pSurveyTaken)` Update Extraction status
`Extraction`	`extractionUpdateSurveyForUser(AuthToken pAuthToken, Extraction pExtraction, SurveyTaken pSurveyTaken, RegistryUser pRbacRegistrySecUserBean)` Update Extraction status
`long`	`getAssetMaxID()`
`FileInfo[]`	`getLatestArtifacts(AuthToken pAuthToken, long pAbstractAssetId, boolean pIsService)` This is a convenience method to ease retrieving artifacts associated with abstract assets in the post-3.0 ALER model.
`void`	`importCheckPermission(AuthToken pAuthToken)` Checks the permission level of the user represented by OER authentication credentials contained in pAuthToken to determine if they are allowed to perform an import.
`void`	`importCleanup(AuthToken pAuthToken, ImpExpJob pJob)` Cleans up a COMPLETED, FAILED, or CANCELLED import job.
`ImpExpJob`	`importExecute(AuthToken pAuthToken, java.lang.String pImportFormat, java.lang.String[] pImportFormatQualifiers, java.lang.String pDesc, byte[] pPayload)` Import a file.
`byte[]`	`importGetAuditB64(AuthToken pAuthToken, ImpExpJob pJobBean, java.lang.String pAuditFormat)` Returns the Audit results of the import operation specified by pJobBean.
`void`	`importGetAuditDIME(AuthToken pAuthToken, ImpExpJob pJobBean, java.lang.String pAuditFormat)` Returns the Audit results of the import operation specified by pJobBean.
`void`	`importGetAuditSwA(AuthToken pAuthToken, ImpExpJob pJobBean, java.lang.String pAuditFormat)` Returns the Audit results of the import operation specified by pJobBean.
`AuditMsg`	`importGetLatestAuditMsg(AuthToken pAuthToken, ImpExpJob pJobBean)` Returns the most recently added Audit message for the given import job.
`void`	`importKill(AuthToken pAuthToken, ImpExpJob pJob)` Terminates a running import job.
`ImpExpJob[]`	`importListJobs(AuthToken pAuthToken)` Returns a list of import jobs currently defined in the system.
`ImpExpJob`	`importStatus(AuthToken pAuthToken, ImpExpJob pJob)` Retrieves an updated description of the current status of the import job.
`MetadataEntrySummary`	`metadataEntryCreateDIME(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)` Creates a new metadata entry.
`MetadataEntrySummary`	`metadataEntryCreateSwA(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)` Creates a new metadata entry.
`void`	`metadataEntryDelete(AuthToken pAuthToken, EntityUUID pEntityUUID)` Deletes a metadata-entry.
`MetadataEntrySummary[]`	`metadataEntryQuery(AuthToken pAuthToken, MetadataEntryCriteria pQuery)` Searches for metadata-entries by entry type or associated entity.
`MetadataEntrySummary`	`metadataEntryReadDIME(AuthToken pAuthToken, EntityUUID pEntityUUID)` Reads a metadata-entry by UUID.
`MetadataEntrySummary`	`metadataEntryReadDIME(AuthToken pAuthToken, long pID)` Reads a metadata-entry by ID.
`MetadataEntrySummary`	`metadataEntryReadSwA(AuthToken pAuthToken, EntityUUID pEntityUUID)` Reads a metadata-entry by UUID.
`MetadataEntrySummary`	`metadataEntryReadSwA(AuthToken pAuthToken, long pID)` Reads a metadata-entry by ID.
`MetadataEntryTypeSummary`	`metadataEntryTypeCreate(AuthToken pAuthToken, java.lang.String pName)` Creates a new metadata entry type.
`void`	`metadataEntryTypeDelete(AuthToken pAuthToken, long pID)` Deletes a metadata entry type.
`MetadataEntryTypeSummary[]`	`metadataEntryTypeQuery(AuthToken pAuthToken, MetadataEntryTypeCriteria pQuery)` Searches for all metadata entry types whose names contain the specified criteria.
`MetadataEntryTypeSummary`	`metadataEntryTypeRead(AuthToken pAuthToken, long pID)` Reads a metadata entry type by ID.
`MetadataEntryTypeSummary`	`metadataEntryTypeUpdate(AuthToken pAuthToken, MetadataEntryTypeSummary pMetadataEntryType)` Updates a metadata entry type.
`MetadataEntrySummary`	`metadataEntryUpdateDIME(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)` Updates a metadata-entry.
`MetadataEntrySummary`	`metadataEntryUpdateSwA(AuthToken pAuthToken, MetadataEntrySummary pMetadataEntrySummary)` Updates a metadata-entry.
`void`	`notificationCreate(AuthToken pAuthTokenBean, java.lang.String pTemplateType, java.lang.String[] pRecipients, NameValue[] pSubstitutions)` Create a new notification.
`java.lang.String[]`	`notificationSubstitutionsRead(AuthToken pAuthTokenBean, java.lang.String pTemplateType)` Retrieve the substitution names available for a notification template type.
`ProjectAssetValue[]`	`projectAssetValueRead(AuthToken pAuthToken, long pProjectID, long pAssetID)` Read ProjectAssetValues
`ProjectAssetValue`	`projectAssetValueReadForUser(AuthToken pAuthToken, long pProjectID, long pAssetID, RegistryUser pRbacRegistrySecUserBean)` Read ProjectAssetValue
`ProjectAssetValueSummary`	`projectAssetValueReadSummary(AuthToken pAuthToken, long pProjectID, long pAssetID)` Read ProjectAssetValueSummary
`AssetUsageType[]`	`projectAssetValueReadTypes(AuthToken pAuthToken)` Read AssetUsageTypes
`ProjectAssetValue`	`projectAssetValueUpdate(AuthToken pAuthToken, ProjectAssetValue pProjectAssetValue, java.lang.String pSelection)` Update ProjectAssetValue
`Project`	`projectCreate(AuthToken pAuthToken, Project pProject, ProjectEntities pProjectEntities)` Create a project.
`Project[]`	`projectQuery(AuthToken pAuthToken, ProjectCriteria pQuery)` Search for a project and return an array of Projects
`ProjectSummary[]`	`projectQuerySummary(AuthToken pAuthToken, ProjectCriteria pQuery)` Search for a project and return an array of ProjectSummaries
`Project`	`projectRead(AuthToken pAuthToken, long pId)` Read a project
`RelatedEntity[]`	`projectReadAppliedComplianceTemplates(AuthToken pAuthToken, Project pProject)` Read applied Compliance Templates
`Project[]`	`projectReadArray(AuthToken pAuthToken, long[] pIds)` Get an array of Project objects from an array of Ids.
`Project[]`	`projectReadArrayFromSummary(AuthToken pAuthToken, ProjectSummary[] pProjectSummaries)` Get an array of Project objects from an array of ProjectSummary objects.
`ProjectAsset[]`	`projectReadAssets(AuthToken pAuthToken, Project pProject)` Read extraction Asset IDs of a project
`java.lang.String[]`	`projectReadChildProjectIDs(AuthToken pAuthToken, Project pProject)` Read related child project IDs.
`Project[]`	`projectReadChildProjects(AuthToken pAuthToken, Project pProject)` Read related child projects.
`java.lang.String[]`	`projectReadExtractionAssetIDs(AuthToken pAuthToken, Project pProject)` Read extraction Asset IDs of a project
`Extraction[]`	`projectReadExtractions(AuthToken pAuthToken, Project pProject)` Read extractions of a project
`java.lang.String[]`	`projectReadLeaderIDs(AuthToken pAuthToken, Project pProject)` Read leader IDs assigned to a project
`RegistryUser[]`	`projectReadLeaders(AuthToken pAuthToken, Project pProject)` Read leaders assigned to a project
`java.lang.String[]`	`projectReadMemberIDs(AuthToken pAuthToken, Project pProject)` Read user IDs assigned to a project
`RegistryUser[]`	`projectReadMembers(AuthToken pAuthToken, Project pProject)` Read users assigned to a project
`java.lang.String[]`	`projectReadParentProjectIDs(AuthToken pAuthToken, Project pProject)` Read related parent project IDs.
`Project[]`	`projectReadParentProjects(AuthToken pAuthToken, Project pProject)` Read related parent projects.
`Asset[]`	`projectReadPrescribedAssets(AuthToken pAuthToken, Project pProject)` Method projectReadPrescribedAssets.
`java.lang.String[]`	`projectReadProducedAssetIDs(AuthToken pAuthToken, Project pProject)` Read produced asset IDs of a project
`Asset[]`	`projectReadProducedAssets(AuthToken pAuthToken, Project pProject)` Read produced assets of a project
`ProjectUserType`	`projectReadUserTypes(AuthToken pAuthToken)` Reads project user types
`void`	`projectReassignExtractions(AuthToken pAuthToken, Project pProject, ExtractionReassignmentDecision[] pReassignIDs)` Assign extractions from one user of a project to another user on the same or different project.
`void`	`projectReassignUsers(AuthToken pAuthToken, Project pProject, ExtractionReassignmentDecision[] pReassignIDs)` Reassigns user and their extractions from one project to another
`Project`	`projectUpdate(AuthToken pAuthToken, Project pProject, ProjectEntities pProjectEntities)` Get an array of Project objects from an array of ProjectSummary objects.
`Results`	`projectValidate(AuthToken pAuthToken, Project pProject, ProjectEntities pProjectEntities)` Validate project.
`boolean`	`rbacHasPermission(AuthToken pAuthToken, long pUserID, java.lang.String[] pRoleContextNames, java.lang.String pPermissionName)` Determine if a user has permission for a given set of rolecontexts, and a permission name.
`RelationshipType`	`relationshipTypeCreate(AuthToken pAuthToken, java.lang.String pName)` Creates a new relationship type.
`void`	`relationshipTypeDelete(AuthToken pAuthToken, long pID)` Deletes a relationship type.
`RelationshipType[]`	`relationshipTypeQuery(AuthToken pAuthToken, RelationshipTypeCriteria pQuery)` Searches for all relationship types that match the specified criteria.
`RelationshipType`	`relationshipTypeRead(AuthToken pAuthToken, long pID)` Reads a relationship type based on a unique ID.
`RelationshipType`	`relationshipTypeUpdate(AuthToken pAuthToken, RelationshipType pRelationshipType)` Updates a relationship type object.
`java.lang.String`	`repositoryFileTranslator(AuthToken pAuthToken, FileInfo pFileInfo)` Given a FileInfo object it returns the download path for the file.
`void`	`retrieveAndRecordUsageOfArtifactCollectionAsDIME(AuthToken pAuthToken, long pAbstractAssetId, long pArtifactRootId, long pProjectId)` This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root.
`void`	`retrieveAndRecordUsageOfArtifactCollectionAsDIME(AuthToken pAuthToken, long pAbstractAssetId, long pArtifactRootId, long pProjectId, RegistryUser pRbacRegistrySecUserBean)` This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root.
`void`	`retrieveAndRecordUsageOfArtifactCollectionAsSwa(AuthToken pAuthToken, long pAbstractAssetId, long pArtifactRootId, long pProjectId)` This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root.
`void`	`retrieveAndRecordUsageOfArtifactCollectionAsSwa(AuthToken pAuthToken, long pAbstractAssetId, long pArtifactRootId, long pProjectId, RegistryUser pRbacRegistrySecUserBean)` This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root.
`void`	`retrieveArtifactCollectionAsDIME(AuthToken pAuthToken, long pAbstractAssetId, long pArtifactRootId)` This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root.
`void`	`retrieveArtifactCollectionAsSwa(AuthToken pAuthToken, long pAbstractAssetId, long pArtifactRootId)` This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root.
`Asset`	`retrieveLatestRootArtifact(AuthToken pAuthToken, long pAbstractAssetId)` This method retrieves a the Asset corresponding to the latest introspected root of collections of related artifact assets which are directly connected to the passed abstract asset (i.e.
`Asset[]`	`retrieveRootArtifacts(AuthToken pAuthToken, long pAbstractAssetId)` This method retrieves a set of Assets corresponding to roots of collections of related artifact assets which are directly connected to the passed abstract asset (i.e.
`ReuseDTO`	`reuseDTORead()` This method returns a composite object containing all the information required to display the reuse portlet.
`Role`	`roleCreate(AuthToken pAuthToken, java.lang.String pName, java.lang.String pDesc, boolean pDefaultForNewUser)` Create a new role.
`void`	`roleDelete(AuthToken pAuthToken, java.lang.String pName)` Delete an existing role.
`Role[]`	`roleQuery(AuthToken pAuthToken, RoleCriteria pCriteria)` Serach for roles.
`Role`	`roleRead(AuthToken pAuthToken, java.lang.String pName)` Retrieve an existing role.
`Role`	`roleUpdate(AuthToken pAuthToken, Role pRoleType)` Update an existing role.
`void`	`sfidAddToAsset(AuthToken pAuthToken, SFIDInfo pSFID, long assetID)` Associates a new SFIDInfo object to the asset specified in the SFIDInfo
`SFIDCandidate[]`	`sfidCandidateQuery(AuthToken pAuthToken, SFIDCriteria pCrit)`
`SFIDCandidate[]`	`sfidCandidateSubmit(AuthToken pAuthToken, SFIDCandidate[] pCandidates)` This method submits a set of SFIDCandidates.
`SFIDInfo[]`	`sfidGenerate(AuthToken pAuthToken, int pMethod)`
`SFIDInfo[]`	`sfidQuery(AuthToken pAuthToken, SFIDCriteria pCrit)` Get all of the SFID values from all of the assets extracted to the specified project
`java.lang.String[]`	`sfidReadValuesByProject(AuthToken pAuthToken, long projectid)` Get all of the SFID values from all of the assets extracted to the specified project
`java.lang.String[]`	`sfidReadValuesForAsset(AuthToken pAuthToken, long assetID)` Get all of the hash values associated with the specified asset
`AssetSummary[]`	`sfidRegisterExtractionBySFIDCandidates(AuthToken pAuthToken, long projectid, SFIDCandidate[] pSFIDCandidates)` Extract all assets with any of the following hash values to the specified project and return an array of asset summaries for the extracted assets.
`void`	`sfidRegisterExtractionBySFIDCandidatesLite(AuthToken pAuthToken, long projectid, SFIDCandidate[] pSFIDCandidates)` Extract all assets with any of the following hash values to the specified project without returning asset summaries for the extracted assets.
`void`	`sfidRegisterExtractionBySFIDValue(AuthToken pAuthToken, long projectid, java.lang.String pSFID)` Extract all assets with the following hash value to the specified project.
`void`	`sfidRegisterExtractionBySFIDValues(AuthToken pAuthToken, long projectid, java.lang.String[] pSFIDs)` Extract all assets with any of the following hash values to the specified project
`AssetSummary[]`	`sfidRegisterExtractionBySFIDValuesResults(AuthToken pAuthToken, long projectid, java.lang.String[] pSFIDs)` Extract all assets with any of the following hash values to the specified project
`void`	`sfidRegisterExtractions(AuthToken pAuthToken, long pProjectID, SFIDCandidate[] pSFIDCandidates, boolean pHarvest)` Register usage of assets to a specified project by matching SFIDs to files that are associated with assets.
`void`	`sfidRemoveAllFromAsset(AuthToken pAuthToken, long assetID)` Remove all of the SFIDInfos associated with the specified asset
`void`	`sfidUpdateAsset(AuthToken pAuthToken, SFIDInfo[] pSFIDs, long assetID)` Remove all of the existing SFIDInfos associated with an asset, and replace them with the new list
`void`	`subscriptionCreate(AuthToken pAuthToken, long[] pAssetIDs, boolean pFailOnAnyError)` Create a subscription for the user identified by pAuthToken to the assets listed in pAssetIDs.
`void`	`subscriptionDelete(AuthToken pAuthToken, long[] pAssetIDs)` Delete an existing subscription for the user identified by pAuthToken to the assets listed in pAssetIDs.
`long[]`	`subscriptionReadSubscribedAssets(AuthToken pAuthToken)` Retrieve the list of assets to which the user identified by pAuthToken is subscribed.
`RegistryUser[]`	`subscriptionReadUsersSubscribedToAsset(AuthToken pAuthTokenBean, long pAssetID)` Return all of the users subscribed to an asset.
`Question[]`	`surveyReadQuestions(AuthToken pAuthToken)` Read Questions
`SurveyTaken`	`surveyTakenRead(AuthToken pAuthToken, Extraction pExtraction)` Read SurveyTaken
`SurveyTaken`	`surveyTakenUpdate(AuthToken pAuthToken, SurveyTaken pSurveyTaken)` Update SurveyTaken
`void`	`systemSettingsAddBundle(AuthToken pAuthToken, java.lang.String pXml)` Adds a XML bundle to the system.
`SettingValue[]`	`systemSettingsQuery(AuthToken pAuthToken, SystemSettingsCriteria pCriteria)` Queries for a system setting
`void`	`testAcceptableValueListDelete(AuthToken pAuthToken, long pID)`
`void`	`testCasCreate(AuthToken pAuthToken, java.lang.String pCasName, java.lang.String pCasType)`
`void`	`testCasDelete(AuthToken pAuthToken, java.lang.String pCasName)`
`void`	`testCleanupNonRunningJobs()`
`void`	`testClearCache(AuthToken pAuthToken, java.lang.String pCacheName)`
`void`	`testClearDatabase()`
`void`	`testCreateCustomAccessSetting(AuthToken pAuthToken, java.lang.String pType, java.lang.String pRoleContextName, boolean pIsDefault)`
`void`	`testDeleteAsset(AuthToken pAuthToken, long pAssetId)`
`void`	`testDeleteAssetType(AuthToken pAuthToken, long pAssetId)`
`void`	`testDeleteProject(AuthToken pAuthToken, long pProjectId)`
`void`	`testDeleteUser(AuthToken pAuthToken, long pUserId)`
`java.lang.String`	`testDetermineDBPlatform()`
`java.lang.String[]`	`testDoSimpleQuery(java.lang.String[] pArgs, java.lang.String pColumnName, java.lang.String pQuery)` Create a subscription for the user identified by pAuthToken to the assets listed in pAssetIDs.
`int`	`testDoSQL(java.lang.String pSQL)`
`void`	`testExtractionResetDatabaseForProject(long pProjectID)`
`boolean`	`testGetLicenseState()`
`java.lang.String`	`testGetSettingValue(java.lang.String pSettingName)`
`boolean`	`testHasSufficientAssets()`
`void`	`testLogMessage(java.lang.String pMessage)`
`void`	`testRestartJobMonitor()`
`void`	`testRoleContextAddRole(AuthToken pAuthToken, java.lang.String pRoleContextName, java.lang.String pRoleName, java.lang.String pRoleOperator)`
`void`	`testRoleContextApplySecuritySettingToExisting(AuthToken pAuthToken, java.lang.String pRoleContextName)`
`void`	`testRoleContextClearRoles(AuthToken pAuthToken, java.lang.String pRoleContextName)`
`java.lang.String[]`	`testRoleContextGetAllRoles(AuthToken pAuthToken, java.lang.String pRoleContextName)`
`java.lang.String`	`testRoleContextGetPermissionFromRole(AuthToken pAuthToken, java.lang.String pRoleContextName, java.lang.String pPermissionName, java.lang.String pRoleName, java.lang.String pRoleOperator)`
`void`	`testRoleContextRemoveRole(AuthToken pAuthToken, java.lang.String pRoleContextName, java.lang.String pRoleName, java.lang.String pRoleOperator)`
`void`	`testRoleContextSetPermission(AuthToken pAuthToken, java.lang.String pRoleContextName, java.lang.String pRoleName, java.lang.String pRoleOperator, PermissionValue pPermissionValueBean)`
`void`	`testRoleContextSetPermissions(AuthToken pAuthToken, java.lang.String pRoleContextName, java.lang.String pRoleName, java.lang.String pRoleOperator, PermissionValue[] pPermssionValueBeans)`
`void`	`testSetLicenseState(boolean pLicensed)`
`void`	`testSetProperty(java.lang.String pPropName, java.lang.String pPropValue)`
`void`	`testSetSetting(java.lang.String pSettingName, java.lang.String pSettingValue)`
`void`	`testThrowImportExportException(boolean pImpExp)`
`void`	`testThrowOpenAPIException()`
`void`	`testUpdateAssetDate(AuthToken pAuthToken, long pAssetID, java.lang.String pDateField, java.util.Calendar pNewDate)`
`void`	`testUpdateProjectAdminRole(long pUserID, boolean pRemove)`
`void`	`testUpdateTabStatus(AuthToken pAuthToken, boolean pApproved, long pUserID, java.lang.String pTab, long pAssetID, java.util.Calendar pDate)`
`void`	`testUpdateUserRole(long pUserID, boolean pRemove)`
`void`	`testUpdateViewAssetSetting(boolean pRemove)`
`void`	`unitTestUserResetDatabase()`
`RegistryUser`	`userActivate(AuthToken pAuthToken, long pId)` Set a user's active status to active.
`RegistryUser`	`userAddRole(AuthToken pAuthToken, long pId, java.lang.String pRoleName)` Add a role to an existing user.
`RegistryUser`	`userCreate(AuthToken pAuthToken, java.lang.String pUserName, java.lang.String pFirstName, java.lang.String pLastName, java.lang.String pEmail, java.lang.String pPassword, boolean pMustChangePassword, boolean pPasswordNeverExpires, boolean pAssignDefaultRoles)` Create a new user.
`RegistryUser`	`userDeactivate(AuthToken pAuthToken, long pId)` Set a user's active status to inactive.
`RegistryUser`	`userLockout(AuthToken pAuthToken, long pId)` Set a user's active status to locked out.
`RegistryUser[]`	`userQuery(AuthToken pAuthToken, UserCriteria pCriteria)` Search for users.
`RegistryUser`	`userRead(AuthToken pAuthToken, long pId)` Retrieve an existing user.
`RegistryUser`	`userReadByAuthToken(AuthToken pAuthToken)` Retrieve an existing user.
`RegistryUser`	`userRemoveRole(AuthToken pAuthToken, long pId, java.lang.String pRoleName)` Removes a role from a user.
`RegistryUser`	`userUnapprove(AuthToken pAuthToken, long pId)` Set a user's active status to unapproved.
`RegistryUser`	`userUpdate(AuthToken pAuthToken, RegistryUser pRbacRegistrySecUserBean)` Update a user.
`Vendor`	`vendorCreate(AuthToken pAuthToken, java.lang.String pName)` Creates a new vendor
`void`	`vendorDelete(AuthToken pAuthToken, long pID)` Deletes a vendor.
`Vendor[]`	`vendorQuery(AuthToken pAuthToken, VendorCriteria pQuery)` Searches for all vendors whose names contain the specified string (ignoring case)
`Vendor`	`vendorRead(AuthToken pAuthToken, long pID)` Reads a vendor
`Vendor`	`vendorUpdate(AuthToken pAuthToken, Vendor pVendor)` Updates a vendor

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

FlashlineRegistrySoapBindingStub

public FlashlineRegistrySoapBindingStub()
                                 throws org.apache.axis.AxisFault

Throws:: org.apache.axis.AxisFault

FlashlineRegistrySoapBindingStub

public FlashlineRegistrySoapBindingStub(java.net.URL endpointURL,
                                        javax.xml.rpc.Service service)
                                 throws org.apache.axis.AxisFault

Throws:: org.apache.axis.AxisFault

FlashlineRegistrySoapBindingStub

public FlashlineRegistrySoapBindingStub(javax.xml.rpc.Service service)
                                 throws org.apache.axis.AxisFault

Throws:: org.apache.axis.AxisFault

Method Detail

createCall

protected org.apache.axis.client.Call createCall()
                                          throws java.rmi.RemoteException

Throws:: java.rmi.RemoteException

assetTypeTabsRead

public TabTypeBean[] assetTypeTabsRead(AuthToken pAuthTokenBean,
                                       long pAssetTypeId)
                                throws java.rmi.RemoteException,
                                       OpenAPIException

Description copied from interface: FlashlineRegistry

Read an assettype's tabs.

Specified by:: assetTypeTabsRead in interface FlashlineRegistry

Parameters:: pAuthTokenBean - The authtoken of the user.; pAssetTypeId - The assettype id.
Returns:: An Array of TabTypeBeans.
Throws:: OpenAPIException; java.rmi.RemoteException

assetTabApprove

public void assetTabApprove(AuthToken pAuthTokenBean,
                            long pAssetId,
                            long pTabId)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Description copied from interface: FlashlineRegistry

Approve an asset's tab.

Specified by:: assetTabApprove in interface FlashlineRegistry

pAssetId - The asset id.; pTabId - The tab id to approve.
Throws:: OpenAPIException; java.rmi.RemoteException

assetTabUnapprove

public void assetTabUnapprove(AuthToken pAuthTokeBean,
                              long pAssetId,
                              long pTabId)
                       throws java.rmi.RemoteException,
                              OpenAPIException

Description copied from interface: FlashlineRegistry

Unapprove an asset's tab.

Specified by:: assetTabUnapprove in interface FlashlineRegistry

Parameters:: pAuthTokeBean - The authtoken of the user.; pAssetId - The asset id.; pTabId - The tab id to unapprove.
Throws:: OpenAPIException; java.rmi.RemoteException

notificationCreate

public void notificationCreate(AuthToken pAuthTokenBean,
                               java.lang.String pTemplateType,
                               java.lang.String[] pRecipients,
                               NameValue[] pSubstitutions)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Description copied from interface: FlashlineRegistry

Create a new notification.

Specified by:: notificationCreate in interface FlashlineRegistry

Parameters:: pAuthTokenBean - The authtoken of the user.; pTemplateType - The template type.; pRecipients - Array of email addresses of who are to receive this notification.; pSubstitutions - Array of NameValue objects to replace placeholders/
Throws:: OpenAPIException; java.rmi.RemoteException

notificationSubstitutionsRead

public java.lang.String[] notificationSubstitutionsRead(AuthToken pAuthTokenBean,
                                                        java.lang.String pTemplateType)
                                                 throws java.rmi.RemoteException,
                                                        OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve the substitution names available for a notification template type.

Specified by:: notificationSubstitutionsRead in interface FlashlineRegistry

Parameters:: pAuthTokenBean - The authtoken of the user.; pTemplateType - The template type.
Returns:: Array of substitution names.
Throws:: OpenAPIException; java.rmi.RemoteException

artifactStoreQuery

public ArtifactStoreBean[] artifactStoreQuery(AuthToken pAuthTokenBean,
                                              ArtifactStoreCriteria pArtifactStoreCritera,
                                              boolean pCreateIfMissing)
                                       throws java.rmi.RemoteException,
                                              OpenAPIException

Description copied from interface: FlashlineRegistry

Find an ArtifactStore that matches the criteria. If an ArtifactStore is not found and pCreateIfMissing is true, then attempt to create a new ArtifactStore and return it.

Specified by:: artifactStoreQuery in interface FlashlineRegistry

Parameters:: pAuthTokenBean - The authtoken of the user requesting this operation.; pArtifactStoreCritera - Criteria to find an ArtifactStore or info to create a missing.; pCreateIfMissing - Create a new ArtifactStore if one is not found based on the criteria (host and basepath criteria must be provided).
Returns:: Array of matching ArtifactStoreBeans
Throws:: OpenAPIException; java.rmi.RemoteException

authTokenCreate

public AuthToken authTokenCreate(java.lang.String userName,
                                 java.lang.String credential)
                          throws java.rmi.RemoteException,
                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Authenticates a user, creating an AuthToken that is used to prove who the user is. Requires the OpenAPI to be licensed on the target system.

Specified by:: authTokenCreate in interface FlashlineRegistry

Parameters:: userName - The username; credential - The credentials/password that authenticates the user
Returns:: The AuthToken that is used to prove who the user is.
Throws:: OpenAPIException - When the user could not be authenticated or the user's account is flagged to change their password; java.rmi.RemoteException

authTokenCreateWithLicense

public AuthToken authTokenCreateWithLicense(java.lang.String userName,
                                            java.lang.String credential,
                                            java.lang.String license)
                                     throws java.rmi.RemoteException,
                                            OpenAPIException

Description copied from interface: FlashlineRegistry

Authenticates a user, creating an AuthToken that is used to prove who the user is. Allows OER authored tools to utilize the OpenAPI on a system which is not licensed to utilitize the OpenAPI in general.

Specified by:: authTokenCreateWithLicense in interface FlashlineRegistry

Parameters:: userName - The username; credential - The credentials/password that authenticates the user; license - OER license key
Returns:: The AuthToken that is used to prove who the user is.
Throws:: OpenAPIException - When the user could not be authenticated or the user's account is flagged to change their password; java.rmi.RemoteException

authTokenDelete

public void authTokenDelete(AuthToken authToken)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Description copied from interface: FlashlineRegistry

Invalidates the OER authentication for a user. After this method is called, the AuthToken is no longer valid and the user must reauthenticate before they can make method calls again.

Specified by:: authTokenDelete in interface FlashlineRegistry

Parameters:: authToken - The AuthToken that was used to prove who the user is.
Throws:: OpenAPIException - When the user's OER authentication could not be invalidated; java.rmi.RemoteException

authTokenValidate

public void authTokenValidate(AuthToken authToken)
                       throws java.rmi.RemoteException,
                              OpenAPIException

Description copied from interface: FlashlineRegistry

Tests the OER authentication token for a user. Returns if the token is still valid, throws an exception otherwise.

Specified by:: authTokenValidate in interface FlashlineRegistry

Parameters:: authToken - The AuthToken that was used to prove who the user is.
Throws:: OpenAPIException - When the user's OER authentication could not be validated; java.rmi.RemoteException

assetCreate

public Asset assetCreate(AuthToken pAuthToken,
                         java.lang.String pName,
                         java.lang.String pVersion,
                         long pAssetTypeID)
                  throws java.rmi.RemoteException,
                         OpenAPIException

Description copied from interface: FlashlineRegistry

Initial creation of a NEW asset. Normally, the asset will be immediately editted to set categorizations, relationships, and acceptable values.

Specified by:: assetCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit permission.; pName - Name of the new asset; pVersion - version of the new asset
Returns:: Asset The newly created asset object
Throws:: OpenAPIException - When the asset could not be created; java.rmi.RemoteException

assetCreateFromXML

public Asset assetCreateFromXML(AuthToken pAuthToken,
                                java.lang.String assetXML)
                         throws java.rmi.RemoteException,
                                OpenAPIException

Description copied from interface: FlashlineRegistry

Initial creation of a NEW asset from an XML representation. The XML must validate with a schema based on the asset type of the asset. The schema can be retrieved through the method assetTypeSchemaRead. Normally, after creation, the asset will be immediately editted to set categorizations, relationships, and acceptable values.

Specified by:: assetCreateFromXML in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; assetXML - The XML from which the asset is created.
Returns:: The Asset
Throws:: OpenAPIException; java.rmi.RemoteException

assetRead

public Asset assetRead(AuthToken pAuthToken,
                       long pId)
                throws java.rmi.RemoteException,
                       OpenAPIException

Description copied from interface: FlashlineRegistry

Get an Asset object by Id.

Specified by:: assetRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. View permission required.; pId - ID of the asset to retrieve
Returns:: Asset The requested Asset
Throws:: OpenAPIException - When the asset could not be read; java.rmi.RemoteException

assetReadXml

public java.lang.String assetReadXml(AuthToken pAuthToken,
                                     long pId)
                              throws java.rmi.RemoteException,
                                     OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve the xml representation for an asset.

Specified by:: assetReadXml in interface FlashlineRegistry

Parameters:: pAuthToken - the auth token used to validate access; pId - the id of the asset for which to read xml
Returns:: the xml for an asset
Throws:: OpenAPIException - for invalid id; java.rmi.RemoteException

assetReadCustomDataString

public java.lang.String assetReadCustomDataString(AuthToken pAuthToken,
                                                  long pId,
                                                  java.lang.String pPath)
                                           throws java.rmi.RemoteException,
                                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Get an Asset custom data node by path

Specified by:: assetReadCustomDataString in interface FlashlineRegistry

Parameters:

pAuthToken - authtoken against which to validate the user. View permission required.

pId - ID of the asset to retrieve

pPath - Path of the node to read relative to custom-data. Examples:

endpoint-uri
users/user/firstname

Returns:

String The value of the requested custom-data field

Throws:

OpenAPIException - When the asset could not be read

java.rmi.RemoteException

assetReadCustomDataNode

public java.lang.String assetReadCustomDataNode(AuthToken pAuthToken,
                                                long pId,
                                                java.lang.String pPath)
                                         throws java.rmi.RemoteException,
                                                OpenAPIException

Description copied from interface: FlashlineRegistry

Get an Asset custom data node's XML by path

Specified by:: assetReadCustomDataNode in interface FlashlineRegistry

Parameters:

pAuthToken - authtoken against which to validate the user. View permission required.

pId - ID of the asset to retrieve

pPath - Path of the node to read relative to custom-data

Returns:

String The requested custom-data node in XML format, for example:

<endpoint-uri>http://myservice:8080</endpoint-uri>

Throws:

OpenAPIException - When the asset could not be read

java.rmi.RemoteException

assetReadArray

public Asset[] assetReadArray(AuthToken pAuthToken,
                              long[] pIds)
                       throws java.rmi.RemoteException,
                              OpenAPIException

Description copied from interface: FlashlineRegistry

Get an array of Asset objects from an array of Ids.

Specified by:: assetReadArray in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have View permission.; pIds - Array of IDs of the assets to retrieve
Returns:: The requested Assets
Throws:: OpenAPIException - When the assets could not be read or the maximum number allowed in one call is exceeded.; java.rmi.RemoteException

assetReadArrayFromSummary

public Asset[] assetReadArrayFromSummary(AuthToken pAuthToken,
                                         AssetSummary[] pAssetSummaries)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Description copied from interface: FlashlineRegistry

Get an array of Asset objects from an array of AssetSummary objects. This is a helper method that is useful when searching for assets, then selectively loading some of the search results.

Specified by:: assetReadArrayFromSummary in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have View permission.; pAssetSummaries - Array of AssetSummary objects for the assets to retrieve
Returns:: The requested Assets
Throws:: OpenAPIException - When the assets could not be read or the maximum number allowed in one call is exceeded.; java.rmi.RemoteException

assetUpdate

public Asset assetUpdate(AuthToken pAuthToken,
                         Asset pAsset)
                  throws java.rmi.RemoteException,
                         OpenAPIException

Description copied from interface: FlashlineRegistry

Updates an Asset, saving any modifications that were made to it.

Specified by:: assetUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit permission.; pAsset - The modified asset to save
Returns:: Asset The asset after the modifications have been saved
Throws:: OpenAPIException - When the asset could not be modified; java.rmi.RemoteException

assetGetUnacceptedFiles

public SubmissionFileInfo[] assetGetUnacceptedFiles(AuthToken pAuthToken,
                                                    long pId)
                                             throws java.rmi.RemoteException,
                                                    OpenAPIException

Specified by:: assetGetUnacceptedFiles in interface FlashlineRegistry

pId - Asset unique identifier
Returns:
Throws:: OpenAPIException; java.rmi.RemoteException

assetAcceptFiles

public void assetAcceptFiles(AuthToken pAuthToken,
                             long pId,
                             java.lang.String[] pFilenames)
                      throws java.rmi.RemoteException,
                             OpenAPIException

Specified by:: assetAcceptFiles in interface FlashlineRegistry

pId - Asset unique identifier; pFilenames - Array of strings containing names of files to be accepted
Throws:: OpenAPIException; java.rmi.RemoteException

assetUpdateCustomDataString

public Asset assetUpdateCustomDataString(AuthToken pAuthToken,
                                         long pAssetID,
                                         java.lang.String pPath,
                                         java.lang.String pValue)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Description copied from interface: FlashlineRegistry

Updates an Asset with a specified custom-data value modification. This method updates only the string contents of the last node in the specified xpath. E.g. supplying path foo/bar/baz and value "some new content" results in:

 <foo>
   <bar>
     <baz>some new content</baz>
   </bar>
 </foo>

Specified by:: assetUpdateCustomDataString in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit permission.; pAssetID - The ID of the asset to modify; pPath - The xpath relative to the custom-data node to save the data, e.g. foo/bar/baz; pValue - The data value to set on the specified xpath node, e.g. "some new content"
Returns:: Asset The asset after the modifications have been saved
Throws:: OpenAPIException - When the asset could not be modified; java.rmi.RemoteException

assetUpdateCustomDataStringArray

public Asset assetUpdateCustomDataStringArray(AuthToken pAuthToken,
                                              long pAssetID,
                                              java.lang.String[] pPath,
                                              java.lang.String[] pValue)
                                       throws java.rmi.RemoteException,
                                              OpenAPIException

Description copied from interface: FlashlineRegistry

Updates an Asset with a specified list of custom-data value modifications. Updates multiple xpath statements at once. This method updates only the string contents of the last node in the specified path. E.g. supplying path foo/bar/baz and value "some new content" results in:

 <foo>
   <bar>
     <baz>some new content</baz>
   </bar>
 </foo>

Specified by:: assetUpdateCustomDataStringArray in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit permission.; pAssetID - The ID of the asset to modify; pPath - The xpath(s) relative to the custom-data node to save the data, e.g. foo/bar/baz; pValue - The data value(s) to set on the specified xpath node, e.g. "some new content"
Returns:: Asset The asset after the modifications have been saved
Throws:: OpenAPIException - When the asset could not be modified; java.rmi.RemoteException

assetUpdateCustomDataNode

public Asset assetUpdateCustomDataNode(AuthToken pAuthToken,
                                       long pAssetID,
                                       java.lang.String pPath,
                                       java.lang.String pValue)
                                throws java.rmi.RemoteException,
                                       OpenAPIException

Description copied from interface: FlashlineRegistry

Updates an Asset with a specified custom-data node modification. This method overwrites the last node in the specified xpath. E.g. supplying path foo/bar/baz and value "<bazchanged>some new content</bazchanged>" results in:

 <foo>
   <bar>
     <bazchanged>some new content</bazchanged>
   </bar>
 </foo>

*Note: pValue completely overwrites the node pointed to by pPath, as shown in the example above.

Specified by:: assetUpdateCustomDataNode in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit permission.; pAssetID - The ID of the asset to modify; pPath - The xpath relative to the custom-data node to save the data, e.g. foo/bar/baz; pValue - The data to set on the specified xpath, e.g. <bazchanged>some new content</bazchanged>
Returns:: Asset The asset after the modifications have been saved
Throws:: OpenAPIException - When the asset could not be modified; java.rmi.RemoteException

assetUpdateCustomDataNodeFromStringArray

public Asset assetUpdateCustomDataNodeFromStringArray(AuthToken pAuthToken,
                                                      long pAssetID,
                                                      java.lang.String[] pPath,
                                                      java.lang.String[] pValue)
                                               throws java.rmi.RemoteException,
                                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Updates an Asset with a specified list of custom-data value modifications. Updates multiple xpath statements at once. This method overwrites the last node in the specified xpath. E.g. supplying path foo/bar/baz and value "<bazchanged>some new content</bazchanged>" results in:

 <foo>
   <bar>
     <bazchanged>some new content</bazchanged>
   </bar>
 </foo>

*Note: pValue completely overwrites the node pointed to by pPath, as shown in the example above.

Specified by:: assetUpdateCustomDataNodeFromStringArray in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit permission.; pAssetID - The ID of the asset to modify; pPath - The xpath(s) relative to the custom-data node to save the data, e.g. foo/bar/baz; pValue - The data value(s) to set on the specified xpath, e.g. <bazchanged>some new content</bazchanged>
Returns:: Asset The asset after the modifications have been saved
Throws:: OpenAPIException - When the asset could not be modified; java.rmi.RemoteException

assetUploadFiles

public void assetUploadFiles(AuthToken pAuthToken,
                             long pAssetID,
                             java.lang.String[] pFilenames)
                      throws java.rmi.RemoteException,
                             OpenAPIException

Description copied from interface: FlashlineRegistry

Upload files into the Flashline Registry UPLOAD repository. Files may be attached using either SOAP with Attachments or DIME. Filenames should be indicated in the pFilenames String array, and should be ordered the same as the attachments.

Specified by:: assetUploadFiles in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit permission for assets.; pAssetID - the asset id to which the files should be uploaded; pFilenames - the names of the files in the same order as the attachments
Throws:: OpenAPIException; java.rmi.RemoteException

assetAddRegistrarNote

public void assetAddRegistrarNote(AuthToken pAuthToken,
                                  long pId,
                                  java.lang.String pNotes)
                           throws java.rmi.RemoteException,
                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Adds a registrar note to the log on the Administration tab

Specified by:: assetAddRegistrarNote in interface FlashlineRegistry

Throws:: OpenAPIException; java.rmi.RemoteException

assetReadRegistrarNotes

public LogEntry[] assetReadRegistrarNotes(AuthToken pAuthToken,
                                          long pId)
                                   throws java.rmi.RemoteException,
                                          OpenAPIException

Description copied from interface: FlashlineRegistry

Reads the log of registrar notes

Specified by:: assetReadRegistrarNotes in interface FlashlineRegistry

Returns:
Throws:: OpenAPIException; java.rmi.RemoteException

assetRegister

public void assetRegister(AuthToken pAuthToken,
                          long pID)
                   throws java.rmi.RemoteException,
                          OpenAPIException

Description copied from interface: FlashlineRegistry

Registers an Asset.

Specified by:: assetRegister in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Register Permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetUnRegister

public void assetUnRegister(AuthToken pAuthToken,
                            long pID)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Description copied from interface: FlashlineRegistry

Unregister an Asset.

Specified by:: assetUnRegister in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Register permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetAccept

public void assetAccept(AuthToken pAuthToken,
                        long pID)
                 throws java.rmi.RemoteException,
                        OpenAPIException

Description copied from interface: FlashlineRegistry

Accept an Asset.

Specified by:: assetAccept in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Accept permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetUnAccept

public void assetUnAccept(AuthToken pAuthToken,
                          long pID)
                   throws java.rmi.RemoteException,
                          OpenAPIException

Description copied from interface: FlashlineRegistry

Unaccept an Asset.

Specified by:: assetUnAccept in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Accept permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetSubmit

public void assetSubmit(AuthToken pAuthToken,
                        long pID)
                 throws java.rmi.RemoteException,
                        OpenAPIException

Description copied from interface: FlashlineRegistry

Submit an Asset.

Specified by:: assetSubmit in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Submit permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetUnSubmit

public void assetUnSubmit(AuthToken pAuthToken,
                          long pID)
                   throws java.rmi.RemoteException,
                          OpenAPIException

Description copied from interface: FlashlineRegistry

Unsubmit an Asset.

Specified by:: assetUnSubmit in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Submit permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetActivate

public void assetActivate(AuthToken pAuthToken,
                          long pAssetID)
                   throws java.rmi.RemoteException,
                          OpenAPIException

Description copied from interface: FlashlineRegistry

Set an Asset's active-status to Active.

Specified by:: assetActivate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have register permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetDeactivate

public void assetDeactivate(AuthToken pAuthToken,
                            long pAssetID)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Description copied from interface: FlashlineRegistry

Set an Asset's active-status to Inactive.

Specified by:: assetDeactivate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Register permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetRetire

public void assetRetire(AuthToken pAuthToken,
                        long pAssetID)
                 throws java.rmi.RemoteException,
                        OpenAPIException

Description copied from interface: FlashlineRegistry

Set an Asset's active-status to Retired.

Specified by:: assetRetire in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Register permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetDelete

public void assetDelete(AuthToken pAuthToken,
                        long pAssetID)
                 throws java.rmi.RemoteException,
                        OpenAPIException

Description copied from interface: FlashlineRegistry

Set an Asset's active-status to Deleted.

Specified by:: assetDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Register permission.
Throws:: java.rmi.RemoteException; OpenAPIException

assetTabsRead

public TabBean[] assetTabsRead(AuthToken pAuthTokenBean,
                               long pAssetId)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve all of the Tabs available for an asset.

Specified by:: assetTabsRead in interface FlashlineRegistry

Parameters:: pAuthTokenBean - authtoken against which to validate the user.; pAssetId - The asset id.
Returns:: An array of AssetTabs.
Throws:: OpenAPIException; java.rmi.RemoteException

assetTabRead

public TabBean assetTabRead(AuthToken pAuthTokenBean,
                            long pAssetId,
                            long pTabTypeBeanId)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Description copied from interface: FlashlineRegistry

Read an asset's tab for a specific TabType.

Specified by:: assetTabRead in interface FlashlineRegistry

Parameters:: pAuthTokenBean - authtoken against which to validate the user.; pAssetId - The asset id.
Returns:: An AssetTab.
Throws:: OpenAPIException; java.rmi.RemoteException

assetQuerySummary

public AssetSummary[] assetQuerySummary(AuthToken pAuthtoken,
                                        AssetCriteria pCriteria)
                                 throws java.rmi.RemoteException,
                                        OpenAPIException

Description copied from interface: FlashlineRegistry

Search for Assets Summaries.

Specified by:: assetQuerySummary in interface FlashlineRegistry

pCriteria - The criteria to search for.
Returns:: AssetSummary[] An array of the asset summary objects that match the criteria.
Throws:: java.rmi.RemoteException; OpenAPIException

assetQuery

public Asset[] assetQuery(AuthToken pAuthtoken,
                          AssetCriteria pCriteria)
                   throws java.rmi.RemoteException,
                          OpenAPIException

Description copied from interface: FlashlineRegistry

Search for Assets.

Specified by:: assetQuery in interface FlashlineRegistry

pCriteria - The criteria to search for.
Returns:: Asset[] An array of the asset objects that match the criteria.
Throws:: java.rmi.RemoteException; OpenAPIException

assetQueryCount

public int assetQueryCount(AuthToken pAuthToken,
                           AssetCriteria pCriteria)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Description copied from interface: FlashlineRegistry

Count the number of assets that would match a query on a specific criteria.

Specified by:: assetQueryCount in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have View permission; pCriteria - The criteria to search for.
Returns:: the number of assets that would match the query
Throws:: java.rmi.RemoteException; OpenAPIException

assetReadAppliedToProjects

public Project[] assetReadAppliedToProjects(AuthToken pAuthToken,
                                            Asset pAsset)
                                     throws java.rmi.RemoteException,
                                            OpenAPIException

Description copied from interface: FlashlineRegistry

Search for projects which compliance template is applied to.

Specified by:: assetReadAppliedToProjects in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have View permission; pAsset - Asset being read from
Returns:: RelatedEntity[] An array of RelatedEntities that stores which projects this template is applied to.
Throws:: OpenAPIException; java.rmi.RemoteException

assetReadAppliedPolicies

public Asset[] assetReadAppliedPolicies(AuthToken pAuthToken,
                                        long pAssetID)
                                 throws java.rmi.RemoteException,
                                        OpenAPIException

Description copied from interface: FlashlineRegistry

Search for policies which are assigned to the specified asset

Specified by:: assetReadAppliedPolicies in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have View permission
Returns:: Asset[] An array of Asset Policies which are applied to the specified asset
Throws:: OpenAPIException; java.rmi.RemoteException

assetUpdateAppliedPolicies

public Asset assetUpdateAppliedPolicies(AuthToken pAuthToken,
                                        long pAssetID,
                                        long[] pAppliedPolicies)
                                 throws java.rmi.RemoteException,
                                        OpenAPIException

Description copied from interface: FlashlineRegistry

Specifies which policies are associated with this asset.

Specified by:: assetUpdateAppliedPolicies in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have View permission; pAppliedPolicies - Policies to apply
Returns:: Asset Updated asset
Throws:: OpenAPIException; java.rmi.RemoteException

assetEvaluate

public KeyValuePair assetEvaluate(AuthToken pAuthToken,
                                  AssetCriteria pCriteria,
                                  java.lang.String pEvaluationName)
                           throws java.rmi.RemoteException,
                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Evaluate Asset attributes.

Specified by:: assetEvaluate in interface FlashlineRegistry

pEvaluationName - The name of what we wish to evaluate
Returns:
Throws:: OpenAPIException; java.rmi.RemoteException

assetEvaluateAgainstAllPolicies

public java.lang.String assetEvaluateAgainstAllPolicies(AuthToken pAuthToken,
                                                        long pAssetID)
                                                 throws java.rmi.RemoteException,
                                                        OpenAPIException

Description copied from interface: FlashlineRegistry

Evaluate an asset against all applied policies. Result "True" indicates that the asset has passed all assertions in all applied policies. Result "False" indicates that the asset has failed at least one assertion in at least one applied policy. Result "Null" indicates that at least one assertion in at least one applied policy has no set result value.

Specified by:: assetEvaluateAgainstAllPolicies in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which the user is validated. Must have View permission; pAssetID - ID of asset being evaluated
Returns:: Evaluation result - one of: true for "pass", false for "fail" or null for "unknown"
Throws:: OpenAPIException; java.rmi.RemoteException

assetEvaluateAgainstPolicy

public java.lang.String assetEvaluateAgainstPolicy(AuthToken pAuthToken,
                                                   long pAssetID,
                                                   long pPolicyID)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Evaluate an asset against a single applied policy. Result "True" indicates that the asset has passed all assertions for the applied policy. Result "False" indicates that the asset has failed at least one assertion in the applied policy. Result "Null" null indicates that at least one assertion in the applied policy has no set result value.

Specified by:: assetEvaluateAgainstPolicy in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which the user is validated. Must have View permission; pAssetID - ID of asset being evaluated; pPolicyID - ID of policy being evaluated
Returns:: Evaluation result - one of: true for "pass", false for "fail" or null for "unknown"
Throws:: OpenAPIException; java.rmi.RemoteException

assetApplyToProjects

public void assetApplyToProjects(AuthToken pAuthToken,
                                 java.lang.String[] pProjectIDs,
                                 Asset pAsset)
                          throws java.rmi.RemoteException,
                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Apply templates to projects

Specified by:: assetApplyToProjects in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectIDs - Projects that the template will be applied to; pAsset - Asset being read from
Throws:: OpenAPIException; java.rmi.RemoteException

assetRemoveAppliedToProjects

public void assetRemoveAppliedToProjects(AuthToken pAuthToken,
                                         java.lang.String[] pProjectIDs,
                                         Asset pAsset)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Description copied from interface: FlashlineRegistry

Removes templates from projects.

Specified by:: assetRemoveAppliedToProjects in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectIDs - Projects that the template will be removed from; pAsset - Asset being read from
Throws:: OpenAPIException; java.rmi.RemoteException

repositoryFileTranslator

public java.lang.String repositoryFileTranslator(AuthToken pAuthToken,
                                                 FileInfo pFileInfo)
                                          throws java.rmi.RemoteException,
                                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Given a FileInfo object it returns the download path for the file.

Specified by:: repositoryFileTranslator in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pFileInfo - FileInfo object required for the File translator
Returns:: String representing the translation.
Throws:: OpenAPIException; java.rmi.RemoteException

categorizationTypeCreate

public CategorizationType categorizationTypeCreate(AuthToken pAuthToken,
                                                   java.lang.String pName,
                                                   java.lang.String pSingularDisplay,
                                                   java.lang.String pPluralDisplay,
                                                   boolean pExclusiveAssign,
                                                   boolean pProjectAssign)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a categorization type

Specified by:: categorizationTypeCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit Asset Type permission.; pName - The name of the new type.; pSingularDisplay - Singular version of the name for display purposes.; pPluralDisplay - Plural version of the name for display purposes.; pExclusiveAssign - If true only one categorization of this type can be applied to an asset.; pProjectAssign - If true then categorizations of this type can be applied to projects.
Returns:: The created categorization type.
Throws:: OpenAPIException; java.rmi.RemoteException

categorizationTypeRead

public CategorizationType categorizationTypeRead(AuthToken pAuthToken,
                                                 long pCategorizationTypeID)
                                          throws java.rmi.RemoteException,
                                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Read categorization type.

Specified by:: categorizationTypeRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pCategorizationTypeID - The ID of the categorization type.
Returns:: CategorizationType The categorization that matches the ID.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationTypeUpdate

public CategorizationType categorizationTypeUpdate(AuthToken pAuthToken,
                                                   CategorizationType pType)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

This only updates the categorization Type, not all of the sub categorizations

Specified by:: categorizationTypeUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit Asset Type permission.
Returns:: CategorizationType The updated CategorizationType.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationTypeDelete

public void categorizationTypeDelete(AuthToken pAuthToken,
                                     CategorizationType pCategorizationType)
                              throws java.rmi.RemoteException,
                                     OpenAPIException

Description copied from interface: FlashlineRegistry

Delete Categorization Type. Also deletes the categorizations of this type.

Specified by:: categorizationTypeDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit Asset Type permission; pCategorizationType - The categorization type to delete.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationTypeQuery

public CategorizationType[] categorizationTypeQuery(AuthToken pAuthToken,
                                                    CategorizationTypeCriteria pCriteria)
                                             throws java.rmi.RemoteException,
                                                    OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve categorization types for a given set of query criteria.

Specified by:: categorizationTypeQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.
Returns:: CategorizationType[] An array of matching categorization types.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationCreate

public Categorization categorizationCreate(AuthToken pAuthToken,
                                           java.lang.String pCategorizationName,
                                           CategorizationType pCategorizationType)
                                    throws java.rmi.RemoteException,
                                           OpenAPIException

Description copied from interface: FlashlineRegistry

Create a categorization

Specified by:: categorizationCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have EditAsset Type permission; pCategorizationName - The name of the new Categorization. It must be unique within the categorization type.; pCategorizationType - The categorization type.
Returns:: Categorization the new categorization
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationChildCreate

public Categorization categorizationChildCreate(AuthToken pAuthToken,
                                                java.lang.String pCategorizationName,
                                                CategorizationType pCategorizationType,
                                                Categorization pSuper)
                                         throws java.rmi.RemoteException,
                                                OpenAPIException

Description copied from interface: FlashlineRegistry

Create a child categorization.

Specified by:: categorizationChildCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit Asset Type permission.; pCategorizationName - The name of the new child categorization.; pCategorizationType - The type of the new child categorization.; pSuper - The parent Categorization.
Returns:: Categorization the child categorization.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationRead

public Categorization categorizationRead(AuthToken pAuthToken,
                                         long pCategorizationID)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve categorization

Specified by:: categorizationRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pCategorizationID - The id of the categorization to return.
Returns:: Categorization The matching categorization.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationReadByType

public Categorization[] categorizationReadByType(AuthToken pAuthToken,
                                                 CategorizationType pCategorizationType,
                                                 boolean active,
                                                 boolean fullTree)
                                          throws java.rmi.RemoteException,
                                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve all categorizations for a categorization types active set to true returns active categorizations fullTree set to true returns categories and their children

Specified by:: categorizationReadByType in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pCategorizationType - The type of the categorizations to get.; active - True to limit array to active categorizations.; fullTree - True to return children of categorizations as well.
Returns:: Categorization[] An array of the matching categorizations.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationChildRead

public Categorization[] categorizationChildRead(AuthToken pAuthToken,
                                                CategorizationType pCategorizationType,
                                                Categorization pCategorization,
                                                boolean active)
                                         throws java.rmi.RemoteException,
                                                OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve all child categorizations for a given categorization.

Specified by:: categorizationChildRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pCategorizationType - The type of the parent Categorization; pCategorization - The parent Categorization.; active - True if you want only active Categorizations.
Returns:: Categorization[] An array of Chile Categorizations
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationUpdate

public Categorization categorizationUpdate(AuthToken pAuthToken,
                                           Categorization pCategorization,
                                           CategorizationType pCategorizationType)
                                    throws java.rmi.RemoteException,
                                           OpenAPIException

Description copied from interface: FlashlineRegistry

Update a single categorization

Specified by:: categorizationUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit Asset Type permission; pCategorization - A Categorization object containing the values to update.; pCategorizationType - The CategorizationType that contains the categorization to update.
Returns:: Categorization The updated categorization.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationUpdateArray

public Categorization[] categorizationUpdateArray(AuthToken pAuthToken,
                                                  Categorization[] pCategorizations,
                                                  CategorizationType pCategorizationType)
                                           throws java.rmi.RemoteException,
                                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Update a list of categorizations within a categorization type.

Specified by:: categorizationUpdateArray in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have the Edit Asset Type permission.; pCategorizationType - The categorization type of the categorizations to update.
Returns:: Categorization[] An array of the updated categorizations
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationDeactivate

public Categorization categorizationDeactivate(AuthToken pAuthToken,
                                               Categorization pCategorization,
                                               CategorizationType pCategorizationType)
                                        throws java.rmi.RemoteException,
                                               OpenAPIException

Description copied from interface: FlashlineRegistry

Deactivate Categorization

Specified by:: categorizationDeactivate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit Asset Type permission; pCategorization - Categorization to deactivate.; pCategorizationType - Type of the categorization to deactivate.
Returns:: Categorization The deactivated categorization.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

categorizationReactivate

public Categorization categorizationReactivate(AuthToken pAuthToken,
                                               Categorization pCategorization,
                                               CategorizationType pCategorizationType)
                                        throws java.rmi.RemoteException,
                                               OpenAPIException

Description copied from interface: FlashlineRegistry

Reactivate Categorization

Specified by:: categorizationReactivate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have Edit Asset Type permission.; pCategorization - The categorization to be reactivated.; pCategorizationType - The categorization type of the categorization to be reactivated.
Returns:: Categorization The reactivated categorization.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

contactCreate

public Contact contactCreate(AuthToken pAuthToken,
                             java.lang.String pName)
                      throws java.rmi.RemoteException,
                             OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new contact.

Specified by:: contactCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pName - the name of the new contact
Returns:: the newly created contact object
Throws:: OpenAPIException - when there is a problem creating the contact; java.rmi.RemoteException

contactRead

public Contact contactRead(AuthToken pAuthToken,
                           long pID)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Description copied from interface: FlashlineRegistry

Reads a contact by ID.

Specified by:: contactRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - the ID of the contact to read
Returns:: the requested contact object
Throws:: OpenAPIException - when there is a problem reading the contact; java.rmi.RemoteException

contactUpdate

public Contact contactUpdate(AuthToken pAuthToken,
                             Contact pContact)
                      throws java.rmi.RemoteException,
                             OpenAPIException

Description copied from interface: FlashlineRegistry

Updates a contact.

Specified by:: contactUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pContact - the modified contact object to be saved
Returns:: the contact object after the modifications have been saved
Throws:: OpenAPIException - when there is a problem updating the contact; java.rmi.RemoteException

contactDelete

public void contactDelete(AuthToken pAuthToken,
                          long pID)
                   throws java.rmi.RemoteException,
                          OpenAPIException

Description copied from interface: FlashlineRegistry

Deletes a contact.

Specified by:: contactDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - the unique ID of the contact to be deleted
Throws:: OpenAPIException - when there is a problem deleting the vendor; java.rmi.RemoteException

contactQuery

public Contact[] contactQuery(AuthToken pAuthToken,
                              ContactCriteria pQuery)
                       throws java.rmi.RemoteException,
                              OpenAPIException

Description copied from interface: FlashlineRegistry

Searches for all contacts whose names contain the specified criteria. Valid criteria includes the contact name as a String. Case is ignored.

Specified by:: contactQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pQuery - a criteria object containing the name of the contact for which to search
Returns:: an array of contact objects matching the criteria, or an empty array if no contacts match
Throws:: OpenAPIException - when there is a problem finding contacts. Note that finding no results will not cause an exception to be thrown.; java.rmi.RemoteException

extractionCreate

public ExtractionDownload[] extractionCreate(AuthToken pAuthToken,
                                             long pProjectId,
                                             long[] pAssetIDs)
                                      throws java.rmi.RemoteException,
                                             OpenAPIException

Description copied from interface: FlashlineRegistry

Create Extraction

Specified by:: extractionCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pAssetIDs - array of asset IDs that are being extracted.
Returns:: An array of extractions.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionGetHiddenAssetUsers

public RegistryUser[] extractionGetHiddenAssetUsers(AuthToken pAuthToken,
                                                    long pProjectID)
                                             throws java.rmi.RemoteException,
                                                    OpenAPIException

Description copied from interface: FlashlineRegistry

Returns an array of users who can view assets consumed by a project that the owner of the AuthTokenBean cannot.

Specified by:: extractionGetHiddenAssetUsers in interface FlashlineRegistry

Parameters:: pAuthToken - authToken against which to validate the user.; pProjectID - Unique Identifier of the project this asset is being consumed by.
Returns:: An array of RbacRegistrySecUserBean objects
Throws:: OpenAPIException; java.rmi.RemoteException

extractionCreateForUser

public ExtractionDownload[] extractionCreateForUser(AuthToken pAuthToken,
                                                    long pProjectID,
                                                    long[] pAssetIDs,
                                                    RegistryUser pRbacRegistrySecUserBean)
                                             throws java.rmi.RemoteException,
                                                    OpenAPIException

Description copied from interface: FlashlineRegistry

Create Extraction

Specified by:: extractionCreateForUser in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectID - Unique Identifier of the project this asset is being extracted to.; pAssetIDs - array of asset IDs that are being extracted.; pRbacRegistrySecUserBean - Object of the user extracting this asset.
Returns:: An array of extractions.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionTentativelyAccept

public Extraction extractionTentativelyAccept(AuthToken pAuthToken,
                                              Extraction pExtraction)
                                       throws java.rmi.RemoteException,
                                              OpenAPIException

Description copied from interface: FlashlineRegistry

Update Extraction state

Specified by:: extractionTentativelyAccept in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pExtraction - Object of the extraction being updated.
Returns:: An extraction.
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionStillEvaluating

public Extraction extractionStillEvaluating(AuthToken pAuthToken,
                                            Extraction pExtraction)
                                     throws java.rmi.RemoteException,
                                            OpenAPIException

Description copied from interface: FlashlineRegistry

Update Extraction state

Specified by:: extractionStillEvaluating in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pExtraction - Object of the extraction being updated.
Returns:: An extraction
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReject

public Extraction extractionReject(AuthToken pAuthToken,
                                   Extraction pExtraction,
                                   Categorization pCategorization,
                                   java.lang.String pComments)
                            throws java.rmi.RemoteException,
                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Reject an extraction.

Specified by:: extractionReject in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pExtraction - Extraction being rejected.; pCategorization - Reason the asset is being rejected.; pComments - Comments regarding the rejection.
Returns:: An extraction
Throws:: OpenAPIException; java.rmi.RemoteException

extractionUpdateSurvey

public Extraction extractionUpdateSurvey(AuthToken pAuthToken,
                                         Extraction pExtraction,
                                         SurveyTaken pSurveyTaken)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Description copied from interface: FlashlineRegistry

Update Extraction status

Specified by:: extractionUpdateSurvey in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pExtraction - Extraction being updated.; pSurveyTaken - Survey Taken being updated or created.
Returns:: An extraction
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionUpdateSurveyForUser

public Extraction extractionUpdateSurveyForUser(AuthToken pAuthToken,
                                                Extraction pExtraction,
                                                SurveyTaken pSurveyTaken,
                                                RegistryUser pRbacRegistrySecUserBean)
                                         throws java.rmi.RemoteException,
                                                OpenAPIException

Description copied from interface: FlashlineRegistry

Update Extraction status

Specified by:: extractionUpdateSurveyForUser in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pExtraction - Extraction being updated.; pSurveyTaken - Survey Taken being updated or created.; pRbacRegistrySecUserBean - User who took the survey and extracted this asset.
Returns:: An extraction
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionRead

public Extraction extractionRead(AuthToken pAuthToken,
                                 long pExtractionID)
                          throws java.rmi.RemoteException,
                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Read Extraction

Specified by:: extractionRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pExtractionID - Unique identifier of the Extraction being requested.
Returns:: An extraction
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadByProjectAndAsset

public Extraction extractionReadByProjectAndAsset(AuthToken pAuthToken,
                                                  long pProjectID,
                                                  long pAssetID)
                                           throws java.rmi.RemoteException,
                                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Read Extraction

Specified by:: extractionReadByProjectAndAsset in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectID - Read any extractions assigned to this project.; pAssetID - Read any extractions for this asset.
Returns:: An extraction
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadUserExtractions

public Extraction[] extractionReadUserExtractions(AuthToken pAuthToken,
                                                  boolean pActive)
                                           throws java.rmi.RemoteException,
                                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Read Extractions

Specified by:: extractionReadUserExtractions in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pActive - Read any extractions with this active status.
Returns:: An array of extractions
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadAssetExtractions

public Extraction[] extractionReadAssetExtractions(AuthToken pAuthToken,
                                                   long pProjectID,
                                                   long pAssetID,
                                                   boolean pActive)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Read Extractions

Specified by:: extractionReadAssetExtractions in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectID - Read any extractions belonging to this project.; pAssetID - Read any extractions for this asset.; pActive - Read any extractions with this active status.
Returns:: An array of extractions
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadProjectExtractions

public Extraction[] extractionReadProjectExtractions(AuthToken pAuthToken,
                                                     long pProjectID,
                                                     boolean pActive)
                                              throws java.rmi.RemoteException,
                                                     OpenAPIException

Description copied from interface: FlashlineRegistry

Read Extractions

Specified by:: extractionReadProjectExtractions in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectID - Read any extractions belonging to this project.; pActive - Read any extractions with this active status.
Returns:: An array of extraction
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadExtractionDownloads

public ExtractionDownload[] extractionReadExtractionDownloads(AuthToken pAuthToken,
                                                              Extraction pExtraction)
                                                       throws java.rmi.RemoteException,
                                                              OpenAPIException

Description copied from interface: FlashlineRegistry

Read extractable files

Specified by:: extractionReadExtractionDownloads in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pExtraction - Read ExtractableDownload array for this extraction.
Returns:: An array of extraction downloads
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadFileInfos

public FileInfo[] extractionReadFileInfos(AuthToken pAuthToken,
                                          Extraction pExtraction)
                                   throws java.rmi.RemoteException,
                                          OpenAPIException

Description copied from interface: FlashlineRegistry

Read file info

Specified by:: extractionReadFileInfos in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pExtraction - Read FileInfo array for this extraction.
Returns:: An array of fileInfos
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadRelatedAssets

public Asset[] extractionReadRelatedAssets(AuthToken pAuthToken,
                                           long pAssetID)
                                    throws java.rmi.RemoteException,
                                           OpenAPIException

Description copied from interface: FlashlineRegistry

Read related Assets

Specified by:: extractionReadRelatedAssets in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pAssetID - Read related assets of this asset.
Returns:: An array of asset
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadRejectionReasons

public Categorization[] extractionReadRejectionReasons(AuthToken pAuthToken)
                                                throws java.rmi.RemoteException,
                                                       OpenAPIException

Description copied from interface: FlashlineRegistry

Read rejection reasons

Specified by:: extractionReadRejectionReasons in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.
Returns:: An array of categorizations
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionReadExtractionStates

public IExtraction extractionReadExtractionStates(AuthToken pAuthToken)
                                           throws java.rmi.RemoteException,
                                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Read Extraction States

Specified by:: extractionReadExtractionStates in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.
Returns:: An IExtractionBean
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

extractionResetDatabase

public void extractionResetDatabase()
                             throws java.rmi.RemoteException,
                                    OpenAPIException

Specified by:: extractionResetDatabase in interface FlashlineRegistry

Throws:: OpenAPIException; java.rmi.RemoteException

projectAssetValueReadForUser

public ProjectAssetValue projectAssetValueReadForUser(AuthToken pAuthToken,
                                                      long pProjectID,
                                                      long pAssetID,
                                                      RegistryUser pRbacRegistrySecUserBean)
                                               throws java.rmi.RemoteException,
                                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Read ProjectAssetValue

Specified by:: projectAssetValueReadForUser in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectID - Read ProjectAssetValue for this project.; pAssetID - Read ProjectAssetValue for this asset.; pRbacRegistrySecUserBean - Read ProjectAssetValue for this user.
Returns:: A ProjectAssetValue
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

projectAssetValueRead

public ProjectAssetValue[] projectAssetValueRead(AuthToken pAuthToken,
                                                 long pProjectID,
                                                 long pAssetID)
                                          throws java.rmi.RemoteException,
                                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Read ProjectAssetValues

Specified by:: projectAssetValueRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectID - Read ProjectAssetValue for this project.; pAssetID - Read ProjectAssetValue for this asset.
Returns:: An array of ProjectAssetValues
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

projectAssetValueReadSummary

public ProjectAssetValueSummary projectAssetValueReadSummary(AuthToken pAuthToken,
                                                             long pProjectID,
                                                             long pAssetID)
                                                      throws java.rmi.RemoteException,
                                                             OpenAPIException

Description copied from interface: FlashlineRegistry

Read ProjectAssetValueSummary

Specified by:: projectAssetValueReadSummary in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectID - Read ProjectAssetValueSummary for this project.; pAssetID - Read ProjectAssetValueSummary for this asset.
Returns:: A ProjectAssetValueSummary object
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

projectAssetValueReadTypes

public AssetUsageType[] projectAssetValueReadTypes(AuthToken pAuthToken)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Read AssetUsageTypes

Specified by:: projectAssetValueReadTypes in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.
Returns:: An array of AssetUsageType objects
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

projectAssetValueUpdate

public ProjectAssetValue projectAssetValueUpdate(AuthToken pAuthToken,
                                                 ProjectAssetValue pProjectAssetValue,
                                                 java.lang.String pSelection)
                                          throws java.rmi.RemoteException,
                                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Update ProjectAssetValue

Specified by:: projectAssetValueUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectAssetValue - ProjectAssetValue being updated.; pSelection - Certified Source selected by the project leader (predicted, consumer, project lead).
Returns:: An ProjectAssetValue Object
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

projectCreate

public Project projectCreate(AuthToken pAuthToken,
                             Project pProject,
                             ProjectEntities pProjectEntities)
                      throws java.rmi.RemoteException,
                             com.flashline.registry.openapi.base.APIValidationException,
                             OpenAPIException

Description copied from interface: FlashlineRegistry

Create a project.

Specified by:: projectCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - Project being created.; pProjectEntities - This stores any linked entities of a project (related projects, users)
Returns:: A Project Object
Throws:: APIValidationException; OpenAPIException; java.rmi.RemoteException

projectRead

public Project projectRead(AuthToken pAuthToken,
                           long pId)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Description copied from interface: FlashlineRegistry

Read a project

Specified by:: projectRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pId - Read this project ID.
Returns:: A Project object
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadArray

public Project[] projectReadArray(AuthToken pAuthToken,
                                  long[] pIds)
                           throws java.rmi.RemoteException,
                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Get an array of Project objects from an array of Ids.

Specified by:: projectReadArray in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pIds - Array of project IDs being read.
Returns:: An array of Project objects.
Throws:: java.rmi.RemoteException; OpenAPIException

projectReadArrayFromSummary

public Project[] projectReadArrayFromSummary(AuthToken pAuthToken,
                                             ProjectSummary[] pProjectSummaries)
                                      throws java.rmi.RemoteException,
                                             OpenAPIException

Description copied from interface: FlashlineRegistry

Get an array of Project objects from an array of ProjectSummary objects. This is a helper method that is useful when searching for projects, then selectively loading some of the search results.

Specified by:: projectReadArrayFromSummary in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProjectSummaries - Array of ProjectSummaries being searched for.
Returns:: An array of Project objects
Throws:: java.rmi.RemoteException; OpenAPIException

projectUpdate

public Project projectUpdate(AuthToken pAuthToken,
                             Project pProject,
                             ProjectEntities pProjectEntities)
                      throws java.rmi.RemoteException,
                             com.flashline.registry.openapi.base.APIValidationException,
                             OpenAPIException

Description copied from interface: FlashlineRegistry

Get an array of Project objects from an array of ProjectSummary objects. This is a helper method that is useful when searching for projects, then selectively loading some of the search results.

Specified by:: projectUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.
Returns:: An array of Project objects
Throws:: java.rmi.RemoteException; com.flashline.registry.openapi.base.APIValidationException; OpenAPIException

projectReadMembers

public RegistryUser[] projectReadMembers(AuthToken pAuthToken,
                                         Project pProject)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Description copied from interface: FlashlineRegistry

Read users assigned to a project

Specified by:: projectReadMembers in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - Project being read from.
Returns:: An array of RbacRegistrySecUserBean objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadMemberIDs

public java.lang.String[] projectReadMemberIDs(AuthToken pAuthToken,
                                               Project pProject)
                                        throws java.rmi.RemoteException,
                                               OpenAPIException

Description copied from interface: FlashlineRegistry

Read user IDs assigned to a project

Specified by:: projectReadMemberIDs in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - Project being read from.
Returns:: An array of Strings representing the Member IDs
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadLeaders

public RegistryUser[] projectReadLeaders(AuthToken pAuthToken,
                                         Project pProject)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Description copied from interface: FlashlineRegistry

Read leaders assigned to a project

Specified by:: projectReadLeaders in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - Project being read from.
Returns:: An array of RbacRegistrySecUserBean objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadLeaderIDs

public java.lang.String[] projectReadLeaderIDs(AuthToken pAuthToken,
                                               Project pProject)
                                        throws java.rmi.RemoteException,
                                               OpenAPIException

Description copied from interface: FlashlineRegistry

Read leader IDs assigned to a project

Specified by:: projectReadLeaderIDs in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - Project being read from.
Returns:: An array of Strings
Throws:: OpenAPIException; java.rmi.RemoteException

projectReassignExtractions

public void projectReassignExtractions(AuthToken pAuthToken,
                                       Project pProject,
                                       ExtractionReassignmentDecision[] pReassignIDs)
                                throws java.rmi.RemoteException,
                                       OpenAPIException

Description copied from interface: FlashlineRegistry

Assign extractions from one user of a project to another user on the same or different project.

Specified by:: projectReassignExtractions in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - Project being updated.; pReassignIDs - This stores an array of ExtractionReassignmentDecision objects. The property, setReassignUserID, stores the ID of the user RECEIVING the extractions. If the ID is set to 0, the extractions will be marked as REJECTED. The property, setProjectID can be set to: 0; the same id as the current project; the id of a different project.
Throws:: OpenAPIException; java.rmi.RemoteException

projectReassignUsers

public void projectReassignUsers(AuthToken pAuthToken,
                                 Project pProject,
                                 ExtractionReassignmentDecision[] pReassignIDs)
                          throws java.rmi.RemoteException,
                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Reassigns user and their extractions from one project to another

Specified by:: projectReassignUsers in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - Project being updated.; pReassignIDs - This stores an array of ExtractionReassignmentDecision objects. The property, setReassignUserID, stores the ID of the user being reassigned. The property, setProjectID stores the id of the project to which the user and their extractions are being reassigned.
Throws:: java.rmi.RemoteException; OpenAPIException

projectReadUserTypes

public ProjectUserType projectReadUserTypes(AuthToken pAuthToken)
                                     throws java.rmi.RemoteException,
                                            OpenAPIException

Description copied from interface: FlashlineRegistry

Reads project user types

Specified by:: projectReadUserTypes in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.
Returns:: A ProjectUserTypeBean object
Throws:: java.rmi.RemoteException; OpenAPIException

projectReadParentProjects

public Project[] projectReadParentProjects(AuthToken pAuthToken,
                                           Project pProject)
                                    throws java.rmi.RemoteException,
                                           OpenAPIException

Description copied from interface: FlashlineRegistry

Read related parent projects.

Specified by:: projectReadParentProjects in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of Project objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadParentProjectIDs

public java.lang.String[] projectReadParentProjectIDs(AuthToken pAuthToken,
                                                      Project pProject)
                                               throws java.rmi.RemoteException,
                                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Read related parent project IDs.

Specified by:: projectReadParentProjectIDs in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of String objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadChildProjects

public Project[] projectReadChildProjects(AuthToken pAuthToken,
                                          Project pProject)
                                   throws java.rmi.RemoteException,
                                          OpenAPIException

Description copied from interface: FlashlineRegistry

Read related child projects.

Specified by:: projectReadChildProjects in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of Project objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadChildProjectIDs

public java.lang.String[] projectReadChildProjectIDs(AuthToken pAuthToken,
                                                     Project pProject)
                                              throws java.rmi.RemoteException,
                                                     OpenAPIException

Description copied from interface: FlashlineRegistry

Read related child project IDs.

Specified by:: projectReadChildProjectIDs in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of String objects representing the Project IDs
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadExtractions

public Extraction[] projectReadExtractions(AuthToken pAuthToken,
                                           Project pProject)
                                    throws java.rmi.RemoteException,
                                           OpenAPIException

Description copied from interface: FlashlineRegistry

Read extractions of a project

Specified by:: projectReadExtractions in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: Array of Extraction objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadExtractionAssetIDs

public java.lang.String[] projectReadExtractionAssetIDs(AuthToken pAuthToken,
                                                        Project pProject)
                                                 throws java.rmi.RemoteException,
                                                        OpenAPIException

Description copied from interface: FlashlineRegistry

Read extraction Asset IDs of a project

Specified by:: projectReadExtractionAssetIDs in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of String objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadAssets

public ProjectAsset[] projectReadAssets(AuthToken pAuthToken,
                                        Project pProject)
                                 throws java.rmi.RemoteException,
                                        OpenAPIException

Description copied from interface: FlashlineRegistry

Read extraction Asset IDs of a project

Specified by:: projectReadAssets in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of ProjectAsset objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadPrescribedAssets

public Asset[] projectReadPrescribedAssets(AuthToken pAuthToken,
                                           Project pProject)
                                    throws java.rmi.RemoteException,
                                           OpenAPIException

Description copied from interface: FlashlineRegistry

Method projectReadPrescribedAssets.

Specified by:: projectReadPrescribedAssets in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of Assets
Throws:: java.rmi.RemoteException; OpenAPIException

projectReadAppliedComplianceTemplates

public RelatedEntity[] projectReadAppliedComplianceTemplates(AuthToken pAuthToken,
                                                             Project pProject)
                                                      throws java.rmi.RemoteException,
                                                             OpenAPIException

Description copied from interface: FlashlineRegistry

Read applied Compliance Templates

Specified by:: projectReadAppliedComplianceTemplates in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken agains which to validate the user.; pProject - project being read from.
Returns:: An array of RelatedEntity objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadProducedAssets

public Asset[] projectReadProducedAssets(AuthToken pAuthToken,
                                         Project pProject)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Description copied from interface: FlashlineRegistry

Read produced assets of a project

Specified by:: projectReadProducedAssets in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of Asset objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectReadProducedAssetIDs

public java.lang.String[] projectReadProducedAssetIDs(AuthToken pAuthToken,
                                                      Project pProject)
                                               throws java.rmi.RemoteException,
                                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Read produced asset IDs of a project

Specified by:: projectReadProducedAssetIDs in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - project being read from.
Returns:: An array of String objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectQuery

public Project[] projectQuery(AuthToken pAuthToken,
                              ProjectCriteria pQuery)
                       throws java.rmi.RemoteException,
                              OpenAPIException

Description copied from interface: FlashlineRegistry

Search for a project and return an array of Projects

Specified by:: projectQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pQuery - ProjectCriteria object that stores the search criteria.
Returns:: An array of Project Objects
Throws:: OpenAPIException; java.rmi.RemoteException

projectQuerySummary

public ProjectSummary[] projectQuerySummary(AuthToken pAuthToken,
                                            ProjectCriteria pQuery)
                                     throws java.rmi.RemoteException,
                                            OpenAPIException

Description copied from interface: FlashlineRegistry

Search for a project and return an array of ProjectSummaries

Specified by:: projectQuerySummary in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pQuery - ProjectCriteria object that stores the search criteria.
Returns:: ProjectSummary[]
Throws:: OpenAPIException; java.rmi.RemoteException

projectValidate

public Results projectValidate(AuthToken pAuthToken,
                               Project pProject,
                               ProjectEntities pProjectEntities)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Description copied from interface: FlashlineRegistry

Validate project. Returns a Results object that contains any validation errors.

Specified by:: projectValidate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pProject - Project being validated.; pProjectEntities - This stores any linked entities of a project (related projects, users)
Returns:: Results
Throws:: java.rmi.RemoteException; OpenAPIException

departmentCreate

public Department departmentCreate(AuthToken pAuthToken,
                                   java.lang.String pName,
                                   java.lang.String pDescription)
                            throws java.rmi.RemoteException,
                                   com.flashline.registry.openapi.base.APIValidationException,
                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new Department. A department with that name cannot already exist.

Specified by:: departmentCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.; pName - The name of the new department. Required.; pDescription - The description of the new department. Optional.
Returns:: Returns the created department.
Throws:: APIValidationException; OpenAPIException; java.rmi.RemoteException

departmentRead

public Department departmentRead(AuthToken pAuthToken,
                                 java.lang.String pKey)
                          throws java.rmi.RemoteException,
                                 com.flashline.registry.openapi.base.APIValidationException,
                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Gets a department by name.

Specified by:: departmentRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have view permission.; pKey - The name of the department
Returns:: Returns the department if found.
Throws:: APIValidationException; OpenAPIException; java.rmi.RemoteException

departmentUpdate

public Department departmentUpdate(AuthToken pAuthToken,
                                   Department pDepartment)
                            throws java.rmi.RemoteException,
                                   com.flashline.registry.openapi.base.APIValidationException,
                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Update a department.

Specified by:: departmentUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.; pDepartment - A department object holding the new values.
Returns:: Returns the updated department.
Throws:: APIValidationException; OpenAPIException; java.rmi.RemoteException

departmentQuery

public Department[] departmentQuery(AuthToken pAuthToken,
                                    DepartmentCriteria pCriteria)
                             throws java.rmi.RemoteException,
                                    com.flashline.registry.openapi.base.APIValidationException,
                                    OpenAPIException

Description copied from interface: FlashlineRegistry

Search for a department.

Specified by:: departmentQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have view permission.; pCriteria - The criteria of the search.
Returns:: returns an array of Department objects.
Throws:: APIValidationException; OpenAPIException; java.rmi.RemoteException

acceptableValueListCreate

public AcceptableValueList acceptableValueListCreate(AuthToken pAuthToken,
                                                     java.lang.String pListName,
                                                     AcceptableValue[] pValues)
                                              throws java.rmi.RemoteException,
                                                     OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new acceptable value list. Acceptable value lists constist of a name and a list of values that make up the list. The name must be unique in the system. If it is not unique, an OpenAPIException will be thrown.

Specified by:: acceptableValueListCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pListName - The name of the acceptable value list - this must be unique; pValues - The list of values that are acceptable for this list
Returns:: The acceptable value list that was just created
Throws:: OpenAPIException - When there is a problem creating the acceptable value list; java.rmi.RemoteException

acceptableValueListRead

public AcceptableValueList acceptableValueListRead(AuthToken pAuthToken,
                                                   long pId)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Read an acceptable value list. This acceptable value list contains the list of the valid values for drop-down boxes and multiple selection lists elements that used in asset custom metadata.

Specified by:: acceptableValueListRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pId - ID of the AcceptableValueList to read
Returns:: AcceptableValueList the AcceptableValueList corresponding to ID pID
Throws:: OpenAPIException - When there is a problem reading the acceptable value list; java.rmi.RemoteException

acceptableValueListUpdate

public AcceptableValueList acceptableValueListUpdate(AuthToken pAuthToken,
                                                     AcceptableValueList pList)
                                              throws java.rmi.RemoteException,
                                                     OpenAPIException

Description copied from interface: FlashlineRegistry

Updates an acceptable value list, modifying both the name of the list and the acceptable values.

Specified by:: acceptableValueListUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pList - The acceptable value list to save
Returns:: The acceptable value list after it has been saved
Throws:: OpenAPIException - When there is a problem updating the acceptable value list; java.rmi.RemoteException

acceptableValueListQuery

public AcceptableValueList[] acceptableValueListQuery(AuthToken pAuthToken,
                                                      AcceptableValueListCriteria pCriteria)
                                               throws java.rmi.RemoteException,
                                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Searches for all acceptable value lists that contains the specified string (ignoring case)

Specified by:: acceptableValueListQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pCriteria - A criteria object containing the name of the list for which to search
Returns:: AcceptableValueList[] The lists matching the name, or an empty array if no lists match the name
Throws:: OpenAPIException - When there is a problem finding the acceptable value lists. Note that finding no results will not cause an exception to be thrown.; java.rmi.RemoteException

assetTypeCreateClone

public AssetType assetTypeCreateClone(AuthToken pAuthToken,
                                      long pBaseAssetTypeID,
                                      java.lang.String pName)
                               throws java.rmi.RemoteException,
                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new asset type based on an existing asset type. The new asset type will be exactly like the old asset type, except for its name and id. After you have created this new asset type, you may update this new asset type without affecting the original asset type.

Specified by:: assetTypeCreateClone in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pBaseAssetTypeID - The ID of the asset type to base the new asset type on.; pName - The name of the new asset type. This name must be unique.
Returns:: The new asset type
Throws:: OpenAPIException - When there is a problem creating the new asset type.; java.rmi.RemoteException

assetTypeCreate

public AssetType assetTypeCreate(AuthToken pAuthToken,
                                 java.lang.String pName)
                          throws java.rmi.RemoteException,
                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new asset type that contains minimal metadata elements.

Specified by:: assetTypeCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pName - The name of the new asset type. This name must be unique.
Returns:: The new asset type
Throws:: OpenAPIException - When there is a problem creating the new asset type.; java.rmi.RemoteException

assetTypeCreateComplianceTemplate

public AssetType assetTypeCreateComplianceTemplate(AuthToken pAuthToken,
                                                   java.lang.String pName)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new compliance template that contains minimal metadata elements.

Specified by:: assetTypeCreateComplianceTemplate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pName - The name of the new asset type. This name must be unique.
Returns:: The new asset type
Throws:: OpenAPIException - When there is a problem creating the new asset type.; java.rmi.RemoteException

assetTypeRead

public AssetType assetTypeRead(AuthToken pAuthToken,
                               long pId)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new compliance template that contains minimal metadata elements.

Specified by:: assetTypeRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user
Returns:: The new asset type
Throws:: OpenAPIException - When there is a problem creating the new asset type.; java.rmi.RemoteException

assetTypeGetEntityArtifactRules

public com.oracle.registry.openapi.entity.EntityArtifactRule[] assetTypeGetEntityArtifactRules(AuthToken pAuthTokenBean,
                                                                                               long pAssetTypeId)
                                                                                        throws java.rmi.RemoteException,
                                                                                               OpenAPIException

Description copied from interface: FlashlineRegistry

Returns an array of EntityArtifactRule for the given Asset Type ID.

Specified by:: assetTypeGetEntityArtifactRules in interface FlashlineRegistry

Parameters:: pAuthTokenBean - authtoken against which to validate the user; pAssetTypeId - The ID of the asset type to retrieve
Returns:: array of EntityArtifactRules
Throws:: OpenAPIException - When there is a problem retrieving the EntityArtifactRules.; java.rmi.RemoteException

assetTypeUpdate

public AssetType assetTypeUpdate(AuthToken pAuthToken,
                                 AssetType pAssetType)
                          throws java.rmi.RemoteException,
                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Updates an existing asset type.

Specified by:: assetTypeUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pAssetType - The updated asset type to save
Returns:: The asset type after it has been updated and saved
Throws:: OpenAPIException - When there is a problem reading the asset type.; java.rmi.RemoteException

assetTypeDelete

public void assetTypeDelete(AuthToken pAuthToken,
                            long pId)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Description copied from interface: FlashlineRegistry

Deletes an existing asset type based on an ID.

Specified by:: assetTypeDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pId - The ID of the asset type to be deleted
Throws:: OpenAPIException - When there is a problem deleting the asset type.; java.rmi.RemoteException

assetTypeQuery

public AssetType[] assetTypeQuery(AuthToken pAuthToken,
                                  AssetTypeCriteria pCriteria)
                           throws java.rmi.RemoteException,
                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Searches for all asset types whose names contain the specified string (ignoring case)

Specified by:: assetTypeQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pCriteria - The search criteria that specify the name to search for
Returns:: The array of asset types matching the name, or an empty array if no asset types match the name
Throws:: OpenAPIException - When there is a problem finding the asset types. Note that finding no results will not cause an exception to be thrown.; java.rmi.RemoteException

assetTypeSchemaRead

public java.lang.String assetTypeSchemaRead(AuthToken pAuthToken,
                                            long pId)
                                     throws java.rmi.RemoteException,
                                            OpenAPIException

Description copied from interface: FlashlineRegistry

Get the xml schema for an asset type. The schema can be used to evaluate the XML of an asset that can then be used in the method assetCreateFromXML.

Specified by:: assetTypeSchemaRead in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user; pId - The ID of the asset type to get the schema.
Returns:: The xml schema for an asset type.
Throws:: OpenAPIException; java.rmi.RemoteException

configGetWebResourcePath

public java.lang.String configGetWebResourcePath()
                                          throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Gets the Web server path to the location where Web resources are stored.

Specified by:: configGetWebResourcePath in interface FlashlineRegistry

Returns:: The setting value
Throws:: java.rmi.RemoteException

systemSettingsAddBundle

public void systemSettingsAddBundle(AuthToken pAuthToken,
                                    java.lang.String pXml)
                             throws java.rmi.RemoteException,
                                    OpenAPIException

Description copied from interface: FlashlineRegistry

Adds a XML bundle to the system.

Specified by:: systemSettingsAddBundle in interface FlashlineRegistry

Throws:: OpenAPIException; java.rmi.RemoteException

systemSettingsQuery

public SettingValue[] systemSettingsQuery(AuthToken pAuthToken,
                                          SystemSettingsCriteria pCriteria)
                                   throws java.rmi.RemoteException,
                                          OpenAPIException

Description copied from interface: FlashlineRegistry

Queries for a system setting

Specified by:: systemSettingsQuery in interface FlashlineRegistry

Returns:: SettingValue object
Throws:: OpenAPIException; java.rmi.RemoteException

userCreate

public RegistryUser userCreate(AuthToken pAuthToken,
                               java.lang.String pUserName,
                               java.lang.String pFirstName,
                               java.lang.String pLastName,
                               java.lang.String pEmail,
                               java.lang.String pPassword,
                               boolean pMustChangePassword,
                               boolean pPasswordNeverExpires,
                               boolean pAssignDefaultRoles)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Description copied from interface: FlashlineRegistry

Create a new user.

Specified by:: userCreate in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have create permission.; pUserName - The username of the new user.; pFirstName - The first name of the new user.; pLastName - The last name of the new user.; pEmail - The email address of the new user.; pPassword - The password of the new user.; pMustChangePassword - True if the user must change password upon next login.; pPasswordNeverExpires - True if the user's password never expires.; pAssignDefaultRoles - True if user is to be automatically assigned default roles.
Returns:: The newly created user.
Throws:: OpenAPIException; java.rmi.RemoteException

userRead

public RegistryUser userRead(AuthToken pAuthToken,
                             long pId)
                      throws java.rmi.RemoteException,
                             OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve an existing user.

Specified by:: userRead in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have view permission.; pId - The id of the user to retrieve.
Returns:: The existing user.
Throws:: OpenAPIException; java.rmi.RemoteException

userReadByAuthToken

public RegistryUser userReadByAuthToken(AuthToken pAuthToken)
                                 throws java.rmi.RemoteException,
                                        OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve an existing user.

Specified by:: userReadByAuthToken in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken for the user to retrieve.
Returns:: The existing user.
Throws:: OpenAPIException; java.rmi.RemoteException

userUpdate

public RegistryUser userUpdate(AuthToken pAuthToken,
                               RegistryUser pRbacRegistrySecUserBean)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Description copied from interface: FlashlineRegistry

Update a user.

Specified by:: userUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have edit permission.; pRbacRegistrySecUserBean - The user to update.
Returns:: The updated user.
Throws:: OpenAPIException; java.rmi.RemoteException

userActivate

public RegistryUser userActivate(AuthToken pAuthToken,
                                 long pId)
                          throws java.rmi.RemoteException,
                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Set a user's active status to active.

Specified by:: userActivate in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have edit permission.; pId - The id of the user.
Returns:: The updated user.
Throws:: OpenAPIException; java.rmi.RemoteException

userDeactivate

public RegistryUser userDeactivate(AuthToken pAuthToken,
                                   long pId)
                            throws java.rmi.RemoteException,
                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Set a user's active status to inactive.

Specified by:: userDeactivate in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have edit permission.; pId - The id of the user.
Returns:: The updated user.
Throws:: OpenAPIException; java.rmi.RemoteException

userLockout

public RegistryUser userLockout(AuthToken pAuthToken,
                                long pId)
                         throws java.rmi.RemoteException,
                                OpenAPIException

Description copied from interface: FlashlineRegistry

Set a user's active status to locked out.

Specified by:: userLockout in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have edit permission.; pId - The id of the user.
Returns:: The locked out user.
Throws:: OpenAPIException; java.rmi.RemoteException

userUnapprove

public RegistryUser userUnapprove(AuthToken pAuthToken,
                                  long pId)
                           throws java.rmi.RemoteException,
                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Set a user's active status to unapproved.

Specified by:: userUnapprove in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have edit permission.; pId - The id of the user.
Returns:: The unapproved user.
Throws:: OpenAPIException; java.rmi.RemoteException

userQuery

public RegistryUser[] userQuery(AuthToken pAuthToken,
                                UserCriteria pCriteria)
                         throws java.rmi.RemoteException,
                                OpenAPIException

Description copied from interface: FlashlineRegistry

Search for users.

Specified by:: userQuery in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have view permission.; pCriteria - The criteria to search for.
Returns:: Array of users that match search criteria.
Throws:: OpenAPIException; java.rmi.RemoteException

userAddRole

public RegistryUser userAddRole(AuthToken pAuthToken,
                                long pId,
                                java.lang.String pRoleName)
                         throws java.rmi.RemoteException,
                                OpenAPIException

Description copied from interface: FlashlineRegistry

Add a role to an existing user.

Specified by:: userAddRole in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have edit permission.; pId - The id of the user.; pRoleName - The name of the role to add to the user.
Returns:: The updated user.
Throws:: OpenAPIException; java.rmi.RemoteException

userRemoveRole

public RegistryUser userRemoveRole(AuthToken pAuthToken,
                                   long pId,
                                   java.lang.String pRoleName)
                            throws java.rmi.RemoteException,
                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Removes a role from a user.

Specified by:: userRemoveRole in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have edit permission.; pId - The id of the user.; pRoleName - The name of the role to remove from the user.
Returns:: An RbacRegistrySecUserBean object
Throws:: OpenAPIException; java.rmi.RemoteException

unitTestUserResetDatabase

public void unitTestUserResetDatabase()
                               throws java.rmi.RemoteException,
                                      OpenAPIException

Specified by:: unitTestUserResetDatabase in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

customAccessSettingNamesGet

public java.lang.String[] customAccessSettingNamesGet(AuthToken pAuthToken,
                                                      java.lang.String pType)
                                               throws java.rmi.RemoteException,
                                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve an array of existing cutom access setting names.

Specified by:: customAccessSettingNamesGet in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have view permission.; pType - The of custom access setting to retrieve (all, asset, file). See customAccessSettingTypesGet.
Returns:: The custom access setting names of specified type.
Throws:: OpenAPIException; java.rmi.RemoteException

customAccessSettingDefaultNamesGet

public java.lang.String[] customAccessSettingDefaultNamesGet(AuthToken pAuthToken,
                                                             java.lang.String pType)
                                                      throws java.rmi.RemoteException,
                                                             OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve an array of the default custom access setting names of a particular type.

Specified by:: customAccessSettingDefaultNamesGet in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have view permission.; pType - The of default custom access setting to retrieve (all, asset, file) See customAccessSettingTypesGet.
Returns:: The default custom access names of specified type.
Throws:: OpenAPIException; java.rmi.RemoteException

customAccessSettingTypesGet

public java.lang.String[] customAccessSettingTypesGet(AuthToken pAuthToken)
                                               throws java.rmi.RemoteException,
                                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve an array of custom access setting types.

Specified by:: customAccessSettingTypesGet in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have view permission.
Returns:: Custom access setting types.
Throws:: OpenAPIException; java.rmi.RemoteException

rbacHasPermission

public boolean rbacHasPermission(AuthToken pAuthToken,
                                 long pUserID,
                                 java.lang.String[] pRoleContextNames,
                                 java.lang.String pPermissionName)
                          throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Determine if a user has permission for a given set of rolecontexts, and a permission name. Note that this method will throw an exception if the user does not have permission to view access control information (view permission on the Basic Access Settings role context).

Specified by:: rbacHasPermission in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have view permission in the BAS role context.; pUserID - user for which to evaluate permissions; pRoleContextNames - names of role contexts to include in evaluation; pPermissionName - the permission name to evaluate
Returns:
Throws:: java.rmi.RemoteException

roleCreate

public Role roleCreate(AuthToken pAuthToken,
                       java.lang.String pName,
                       java.lang.String pDesc,
                       boolean pDefaultForNewUser)
                throws java.rmi.RemoteException,
                       OpenAPIException

Description copied from interface: FlashlineRegistry

Create a new role.

Specified by:: roleCreate in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have create permission.; pName - The name of the the new role.; pDesc - The description of the new role.; pDefaultForNewUser - True if this new role is to be assigned by default to new users.
Returns:: The new role.
Throws:: OpenAPIException; java.rmi.RemoteException

roleRead

public Role roleRead(AuthToken pAuthToken,
                     java.lang.String pName)
              throws java.rmi.RemoteException,
                     OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve an existing role.

Specified by:: roleRead in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have create permission.; pName - The name of the role to retrieve.
Returns:: The specified role.
Throws:: OpenAPIException; java.rmi.RemoteException

roleUpdate

public Role roleUpdate(AuthToken pAuthToken,
                       Role pRoleType)
                throws java.rmi.RemoteException,
                       OpenAPIException

Description copied from interface: FlashlineRegistry

Update an existing role.

Specified by:: roleUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have edit permission.; pRoleType - The role to update.
Returns:: The updated role.
Throws:: OpenAPIException; java.rmi.RemoteException

roleDelete

public void roleDelete(AuthToken pAuthToken,
                       java.lang.String pName)
                throws java.rmi.RemoteException,
                       OpenAPIException

Description copied from interface: FlashlineRegistry

Delete an existing role.

Specified by:: roleDelete in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have delete permission.; pName - The name of the role to delete.
Throws:: OpenAPIException; java.rmi.RemoteException

roleQuery

public Role[] roleQuery(AuthToken pAuthToken,
                        RoleCriteria pCriteria)
                 throws java.rmi.RemoteException,
                        OpenAPIException

Description copied from interface: FlashlineRegistry

Serach for roles.

Specified by:: roleQuery in interface FlashlineRegistry

Parameters:: pAuthToken - Authtoken against which to validate the user. Must have view permission.; pCriteria - The criteria to search for.
Returns:: The roles that match the search criteria.
Throws:: OpenAPIException; java.rmi.RemoteException

relationshipTypeCreate

public RelationshipType relationshipTypeCreate(AuthToken pAuthToken,
                                               java.lang.String pName)
                                        throws java.rmi.RemoteException,
                                               OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new relationship type.

Specified by:: relationshipTypeCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pName - name of the new relationship type
Returns:: the new relationship type
Throws:: OpenAPIException - when there is a problem creating the relationship type; java.rmi.RemoteException

relationshipTypeRead

public RelationshipType relationshipTypeRead(AuthToken pAuthToken,
                                             long pID)
                                      throws java.rmi.RemoteException,
                                             OpenAPIException

Description copied from interface: FlashlineRegistry

Reads a relationship type based on a unique ID.

Specified by:: relationshipTypeRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - the ID of the relationship type to retrieve
Returns:: the requested relationship type
Throws:: OpenAPIException - when there is a problem reading the relationship type; java.rmi.RemoteException

relationshipTypeUpdate

public RelationshipType relationshipTypeUpdate(AuthToken pAuthToken,
                                               RelationshipType pRelationshipType)
                                        throws java.rmi.RemoteException,
                                               OpenAPIException

Description copied from interface: FlashlineRegistry

Updates a relationship type object.

Specified by:: relationshipTypeUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pRelationshipType - the updated relationship type
Returns:: the updated relationship type after it has been saved
Throws:: OpenAPIException - when there is a problem reading the relationship type; java.rmi.RemoteException

relationshipTypeDelete

public void relationshipTypeDelete(AuthToken pAuthToken,
                                   long pID)
                            throws java.rmi.RemoteException,
                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Deletes a relationship type.

Specified by:: relationshipTypeDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - the ID of the relationship type to delete
Throws:: OpenAPIException - when there is a problem deleting the relationship type; java.rmi.RemoteException

relationshipTypeQuery

public RelationshipType[] relationshipTypeQuery(AuthToken pAuthToken,
                                                RelationshipTypeCriteria pQuery)
                                         throws java.rmi.RemoteException,
                                                OpenAPIException

Description copied from interface: FlashlineRegistry

Searches for all relationship types that match the specified criteria. Valid criteria includes the relationship type name as a String. Case is ignored.

Specified by:: relationshipTypeQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pQuery - a criteria object containing the name of the relationship type for which to search
Returns:: an array of relationship types matching the criteria, or an empty array if no relationship types match
Throws:: OpenAPIException - when there is a problem finding relationship types. Note that finding no results will not cause an exception to be thrown.; java.rmi.RemoteException

surveyTakenRead

public SurveyTaken surveyTakenRead(AuthToken pAuthToken,
                                   Extraction pExtraction)
                            throws java.rmi.RemoteException,
                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Read SurveyTaken

Specified by:: surveyTakenRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pExtraction - Object of the extraction being updated.
Returns:: An SurveyTaken Object
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

surveyReadQuestions

public Question[] surveyReadQuestions(AuthToken pAuthToken)
                               throws java.rmi.RemoteException,
                                      OpenAPIException

Description copied from interface: FlashlineRegistry

Read Questions

Specified by:: surveyReadQuestions in interface FlashlineRegistry

Parameters:: pAuthToken - pAuthToken authtoken against which to validate the user
Returns:: An array of Question objects
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

surveyTakenUpdate

public SurveyTaken surveyTakenUpdate(AuthToken pAuthToken,
                                     SurveyTaken pSurveyTaken)
                              throws java.rmi.RemoteException,
                                     OpenAPIException

Description copied from interface: FlashlineRegistry

Update SurveyTaken

Specified by:: surveyTakenUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - pAuthToken authtoken against which to validate the user; pSurveyTaken - Survey Taken being updated or created.
Returns:: A SurveyTaken object
Throws:: OpenAPIException - if anything goes wrong; java.rmi.RemoteException

vendorCreate

public Vendor vendorCreate(AuthToken pAuthToken,
                           java.lang.String pName)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new vendor

Specified by:: vendorCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pName - Name of the new vendor. Maximum length = 250.
Returns:: The new vendor
Throws:: OpenAPIException - When there is a problem creating the vendor; java.rmi.RemoteException

vendorRead

public Vendor vendorRead(AuthToken pAuthToken,
                         long pID)
                  throws java.rmi.RemoteException,
                         OpenAPIException

Description copied from interface: FlashlineRegistry

Reads a vendor

Specified by:: vendorRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - The ID of the vendor to read
Returns:: the requested vendor
Throws:: OpenAPIException - When there is a problem reading the vendor; java.rmi.RemoteException

vendorUpdate

public Vendor vendorUpdate(AuthToken pAuthToken,
                           Vendor pVendor)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Description copied from interface: FlashlineRegistry

Updates a vendor

Specified by:: vendorUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pVendor - the updated vendor
Returns:: the vendor after it has been updated
Throws:: OpenAPIException - When there is a problem updating the vendor; java.rmi.RemoteException

vendorDelete

public void vendorDelete(AuthToken pAuthToken,
                         long pID)
                  throws java.rmi.RemoteException,
                         OpenAPIException

Description copied from interface: FlashlineRegistry

Deletes a vendor.

Specified by:: vendorDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - The ID of the vendor to delete
Throws:: OpenAPIException - When there is a problem deleting the vendor; java.rmi.RemoteException

vendorQuery

public Vendor[] vendorQuery(AuthToken pAuthToken,
                            VendorCriteria pQuery)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Description copied from interface: FlashlineRegistry

Searches for all vendors whose names contain the specified string (ignoring case)

Specified by:: vendorQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pQuery - A criteria object containing the name of the vendor for which to search
Returns:: The vendors matching the name, or an empty array if no vendors match the name
Throws:: OpenAPIException - When there is a problem finding vendors. Note that finding no results will not cause an exception to be thrown.; java.rmi.RemoteException

exportListJobs

public ImpExpJob[] exportListJobs(AuthToken pAuthToken)
                           throws java.rmi.RemoteException,
                                  OpenAPIException,
                                  ImportExportException

Description copied from interface: FlashlineRegistry

Returns a list of export jobs currently defined in the system. The jobs may or may not be currently running.

Specified by:: exportListJobs in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export
Returns:: an array of ImpExpJob beans describing the currently defined jobs
Throws:: OpenAPIException; ImportExportException; java.rmi.RemoteException

exportExecute

public ImpExpJob exportExecute(AuthToken pAuthToken,
                               java.lang.String pExportFormat,
                               java.lang.String[] pExportFormatQualifiers,
                               java.lang.String pDesc,
                               java.lang.String pQueryFormat,
                               java.lang.String pQuery)
                        throws java.rmi.RemoteException,
                               OpenAPIException,
                               ImportExportException

Description copied from interface: FlashlineRegistry

Starts an export job running on the server. This method is NON-BLOCKING. That is, if the job is successfully started, this method immediately returns a JobBean that represents the state of the started export job. The caller is then expected to make subsequent calls to the exportStatus method to determine the status of the running export job. The returned JobBean is the "handle" to the export job, and should be retained so that it can be passed in future calls to other methods in the ImportExport subsystem.

Specified by:: exportExecute in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pDesc - a description of the export job.
Returns:: a JobBean describing the current state of the export job.
Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException

exportGetAuditB64

public byte[] exportGetAuditB64(AuthToken pAuthToken,
                                ImpExpJob pJobBean,
                                java.lang.String pAuditFormat)
                         throws java.rmi.RemoteException,
                                OpenAPIException,
                                ImportExportException

Description copied from interface: FlashlineRegistry

Returns the Audit results of the export operation specified by pJobBean. The results are delivered as a Base64 encoded payload. Note that this method can cause HUGE memory consumption on the application server (roughly three times the size of the delivered payload will be used from the heap). Note that other delivery mechanisms are availalbe (DIME and Soap with Attachments).

Specified by:: exportGetAuditB64 in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pJobBean - the handle of the job for which to retrieve results; pAuditFormat - currently, the only supported format is "plaintext".
Returns:: a Base64 encoded representation of the export audit results.
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetAuditDIME(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String), FlashlineRegistry.exportGetAuditSwA(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String)

exportGetAuditDIME

public void exportGetAuditDIME(AuthToken pAuthToken,
                               ImpExpJob pJobBean,
                               java.lang.String pAuditFormat)
                        throws java.rmi.RemoteException,
                               OpenAPIException,
                               ImportExportException

Description copied from interface: FlashlineRegistry

Returns the Audit results of the export operation specified by pJobBean. The results are delivered as a DIME encoded attachement. Note that other delivery mechanisms are availalbe (Base64 and Soap with Attachments).

Specified by:: exportGetAuditDIME in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pJobBean - the handle of the job for which to retrieve results; pAuditFormat - currently, the only supported format is "plaintext".
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetAuditB64(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String), FlashlineRegistry.exportGetAuditSwA(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String)

exportGetAuditSwA

public void exportGetAuditSwA(AuthToken pAuthToken,
                              ImpExpJob pJobBean,
                              java.lang.String pAuditFormat)
                       throws java.rmi.RemoteException,
                              OpenAPIException,
                              ImportExportException

Description copied from interface: FlashlineRegistry

Returns the Audit results of the export operation specified by pJobBean. The results are delivered as a Soap with Attachments encoded attachement. Note that other delivery mechanisms are available (Base64 and DIME).

Specified by:: exportGetAuditSwA in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pJobBean - the handle of the job for which to retrieve results; pAuditFormat - currently, the only supported format is "plaintext".
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetAuditB64(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String), FlashlineRegistry.exportGetAuditDIME(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String)

exportGetLatestAuditMsg

public AuditMsg exportGetLatestAuditMsg(AuthToken pAuthToken,
                                        ImpExpJob pJobBean)
                                 throws java.rmi.RemoteException,
                                        OpenAPIException,
                                        ImportExportException

Description copied from interface: FlashlineRegistry

Returns the most recently added Audit message for the given export job. Suitable for status displays during export operations.

Specified by:: exportGetLatestAuditMsg in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pJobBean - the handle of the job for which to retrieve the latest audit message
Returns:: on object encapsulating the most recent audit message.
Throws:: OpenAPIException; ImportExportException; java.rmi.RemoteException

importGetAuditB64

public byte[] importGetAuditB64(AuthToken pAuthToken,
                                ImpExpJob pJobBean,
                                java.lang.String pAuditFormat)
                         throws java.rmi.RemoteException,
                                OpenAPIException,
                                ImportExportException

Description copied from interface: FlashlineRegistry

Returns the Audit results of the import operation specified by pJobBean. The results are delivered as a Base64 encoded payload. Note that this method can cause HUGE memory consumption on the application server (roughly three times the size of the delivered payload will be used from the heap). Note that other delivery mechanisms are availalbe (DIME and Soap with Attachments).

Specified by:: importGetAuditB64 in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the import; pJobBean - the handle of the job for which to retrieve results; pAuditFormat - currently, the only supported format is "plaintext".
Returns:: a Base64 encoded representation of the import audit results.
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetAuditDIME(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String), FlashlineRegistry.exportGetAuditSwA(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String)

importGetAuditDIME

public void importGetAuditDIME(AuthToken pAuthToken,
                               ImpExpJob pJobBean,
                               java.lang.String pAuditFormat)
                        throws java.rmi.RemoteException,
                               OpenAPIException,
                               ImportExportException

Description copied from interface: FlashlineRegistry

Returns the Audit results of the import operation specified by pJobBean. The results are delivered as a DIME encoded attachment. Note that other delivery mechanisms are availalbe (Base64 and Soap with Attachments).

Specified by:: importGetAuditDIME in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the import; pJobBean - the handle of the job for which to retrieve results; pAuditFormat - currently, the only supported format is "plaintext".
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetAuditB64(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String), FlashlineRegistry.exportGetAuditSwA(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String)

importGetAuditSwA

public void importGetAuditSwA(AuthToken pAuthToken,
                              ImpExpJob pJobBean,
                              java.lang.String pAuditFormat)
                       throws java.rmi.RemoteException,
                              OpenAPIException,
                              ImportExportException

Description copied from interface: FlashlineRegistry

Returns the Audit results of the import operation specified by pJobBean. The results are delivered as a Soap with Attachments encoded attachment. Note that other delivery mechanisms are availalbe (Base64 and DIME).

Specified by:: importGetAuditSwA in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the import; pJobBean - the handle of the job for which to retrieve results; pAuditFormat - currently, the only supported format is "plaintext".
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetAuditB64(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String), FlashlineRegistry.exportGetAuditDIME(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob, java.lang.String)

importGetLatestAuditMsg

public AuditMsg importGetLatestAuditMsg(AuthToken pAuthToken,
                                        ImpExpJob pJobBean)
                                 throws java.rmi.RemoteException,
                                        OpenAPIException,
                                        ImportExportException

Description copied from interface: FlashlineRegistry

Returns the most recently added Audit message for the given import job. Suitable for status displays during long-running import operations.

Specified by:: importGetLatestAuditMsg in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the import; pJobBean - the handle of the job for which to retrieve the latest audit message
Returns:: on object encapsulating the most recent audit message.
Throws:: OpenAPIException; ImportExportException; java.rmi.RemoteException

exportStatus

public ImpExpJob exportStatus(AuthToken pAuthToken,
                              ImpExpJob pJob)
                       throws java.rmi.RemoteException,
                              OpenAPIException,
                              ImportExportException

Description copied from interface: FlashlineRegistry

Retrieves an updated description of the current status of the export job. This method is typically called repetitively to monitor the status of a running job, and inform the end user of the job's progress.

Specified by:: exportStatus in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pJob - the handle of the job for which to retrieve updated status
Returns:: an updated JobBean, containing status information for the running job.
Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException

exportKill

public void exportKill(AuthToken pAuthToken,
                       ImpExpJob pJob)
                throws java.rmi.RemoteException,
                       OpenAPIException,
                       ImportExportException

Description copied from interface: FlashlineRegistry

Terminates a running export job. The terminated job is left in tact (i.e., the audit, payload, etc. is not disturbed). To completely remove the job, a call to exportCleanup must be made.

Specified by:: exportKill in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pJob - the handle of the job to kill
Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException

exportGetResultsB64

public byte[] exportGetResultsB64(AuthToken pAuthToken,
                                  ImpExpJob pJob)
                           throws java.rmi.RemoteException,
                                  OpenAPIException,
                                  ImportExportException

Description copied from interface: FlashlineRegistry

Returns the results of the export operation (i.e., the "payload") specified by pJobBean. The results are delivered as a Base64 encoded payload. Note that this method can cause HUGE memory consumption on the application server (roughly three times the size of the delivered payload will be used from the heap). Note that other delivery mechanisms are availalbe (DIME and Soap with Attachments).

Specified by:: exportGetResultsB64 in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export
Returns:: a Base64 encoded representation of the export results.
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetResultsDIME(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob), FlashlineRegistry.exportGetResultsSwA(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob)

exportGetResultsDIME

public void exportGetResultsDIME(AuthToken pAuthToken,
                                 ImpExpJob pJob)
                          throws java.rmi.RemoteException,
                                 OpenAPIException,
                                 ImportExportException

Description copied from interface: FlashlineRegistry

Returns the results of the export operation (i.e., the "payload") specified by pJobBean. The results are delivered as a DIME encoded attachment. Note that other delivery mechanisms are availalbe (Base64 and Soap with Attachments).

Specified by:: exportGetResultsDIME in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetResultsB64(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob), FlashlineRegistry.exportGetResultsSwA(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob)

exportGetResultsSwA

public void exportGetResultsSwA(AuthToken pAuthToken,
                                ImpExpJob pJob)
                         throws java.rmi.RemoteException,
                                OpenAPIException,
                                ImportExportException

Description copied from interface: FlashlineRegistry

Returns the results of the export operation (i.e., the "payload") specified by pJobBean. The results are delivered as a Soap with Attachments encoded attachment. Note that other delivery mechanisms are availalbe (Base64 and DIME).

Specified by:: exportGetResultsSwA in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export
Throws:: ImportExportException; java.rmi.RemoteException; OpenAPIException
See Also:: FlashlineRegistry.exportGetResultsB64(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob), FlashlineRegistry.exportGetResultsDIME(com.flashline.registry.openapi.entity.AuthToken, com.flashline.registry.openapi.entity.ImpExpJob)

exportCleanup

public void exportCleanup(AuthToken pAuthToken,
                          ImpExpJob pJob)
                   throws java.rmi.RemoteException,
                          OpenAPIException,
                          ImportExportException

Description copied from interface: FlashlineRegistry

Cleans up a COMPLETED, FAILED, or CANCELLED export job. If a job is currently running, an ImportExportException is thrown. Performs the following cleanup tasks:

Removes the job from the job registry. That is, the job id will no longer be defined.
Deletes the audit trail for the job.
Deletes the results of the export from the export cache (i.e., the databse).

Specified by:: exportCleanup in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pJob - the handle of the job for which to retrieve results
Throws:: OpenAPIException; ImportExportException; java.rmi.RemoteException

importListJobs

public ImpExpJob[] importListJobs(AuthToken pAuthToken)
                           throws java.rmi.RemoteException,
                                  OpenAPIException,
                                  ImportExportException

Description copied from interface: FlashlineRegistry

Returns a list of import jobs currently defined in the system. The jobs may or may not be currently running.

Specified by:: importListJobs in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the import
Returns:: an array of ImpExpJob beans describing the currently defined jobs
Throws:: OpenAPIException; ImportExportException; java.rmi.RemoteException

importExecute

public ImpExpJob importExecute(AuthToken pAuthToken,
                               java.lang.String pImportFormat,
                               java.lang.String[] pImportFormatQualifiers,
                               java.lang.String pDesc,
                               byte[] pPayload)
                        throws java.rmi.RemoteException,
                               OpenAPIException,
                               ImportExportException

Description copied from interface: FlashlineRegistry

Import a file. If pPayload is present, will use the Base64-encoded file passed in that parameter. If pPayload is null, checks for SwA or DIME based attachments, and uses those as the payload. Note that this method is non-blocking. It returns a job handle immediatedly (assuming that the import starts successfully). The job handle should then be used to monitor status of the running job.

Specified by:: importExecute in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the export; pDesc - a descripton of the import job.; pPayload - the Base64-encoded payload. DO NOT included this parameter (i.e., leave it null) if you are planning on using DIME or SwA for passing the payload.
Returns:: a handle to the running job.
Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException

importStatus

public ImpExpJob importStatus(AuthToken pAuthToken,
                              ImpExpJob pJob)
                       throws java.rmi.RemoteException,
                              OpenAPIException,
                              ImportExportException

Description copied from interface: FlashlineRegistry

Retrieves an updated description of the current status of the import job. This method is typically called repetitively to monitor the status of a running job, and inform the end user of the job's progress.

Specified by:: importStatus in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the import; pJob - the handle of the job for which to retrieve updated status
Returns:: an updated JobBean, containing status information for the running job.
Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException

importKill

public void importKill(AuthToken pAuthToken,
                       ImpExpJob pJob)
                throws java.rmi.RemoteException,
                       OpenAPIException,
                       ImportExportException

Description copied from interface: FlashlineRegistry

Terminates a running import job. The terminated job is left in tact (i.e., the audit, payload, etc. is not disturbed). To completely remove the job, a call to importCleanup must be made.

Specified by:: importKill in interface FlashlineRegistry

Parameters:: pAuthToken - the credentials of the user performing the import; pJob - the handle of the job to kill
Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException

importCheckPermission

public void importCheckPermission(AuthToken pAuthToken)
                           throws java.rmi.RemoteException,
                                  OpenAPIException,
                                  ImportExportException

Description copied from interface: FlashlineRegistry

Checks the permission level of the user represented by OER authentication credentials contained in pAuthToken to determine if they are allowed to perform an import. If the user does NOT have appropriate privileges, an ImportExportException will be thrown.

Specified by:: importCheckPermission in interface FlashlineRegistry

Parameters:: pAuthToken - the user for which to check permissions.
Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException
See Also:: FlashlineRegistry.authTokenCreate(java.lang.String, java.lang.String)

exportCheckPermission

public void exportCheckPermission(AuthToken pAuthToken)
                           throws java.rmi.RemoteException,
                                  OpenAPIException,
                                  ImportExportException

Description copied from interface: FlashlineRegistry

Checks the permission level of the user represented by OER authentication credentials contained in pAuthToken to determine if they are allowed to perform an export. If the user does NOT have appropriate privileges, an ImportExportException will be thrown.

Specified by:: exportCheckPermission in interface FlashlineRegistry

Parameters:: pAuthToken - the user for which to check permissions.
Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException
See Also:: FlashlineRegistry.authTokenCreate(java.lang.String, java.lang.String)

importCleanup

public void importCleanup(AuthToken pAuthToken,
                          ImpExpJob pJob)
                   throws java.rmi.RemoteException,
                          OpenAPIException,
                          ImportExportException

Description copied from interface: FlashlineRegistry

Cleans up a COMPLETED, FAILED, or CANCELLED import job. If a job is currently running, an ImportExportException is thrown. Performs the following cleanup tasks:

Removes the job from the job registry. That is, the job id will no longer be defined.
Deletes the audit trail for the job.

Specified by:: importCleanup in interface FlashlineRegistry

Parameters:: pAuthToken - the user for which to check permissions.; pJob - the handle of the job to cleanup
Throws:: OpenAPIException; ImportExportException; java.rmi.RemoteException

testClearCache

public void testClearCache(AuthToken pAuthToken,
                           java.lang.String pCacheName)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Specified by:: testClearCache in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testUpdateAssetDate

public void testUpdateAssetDate(AuthToken pAuthToken,
                                long pAssetID,
                                java.lang.String pDateField,
                                java.util.Calendar pNewDate)
                         throws java.rmi.RemoteException

Specified by:: testUpdateAssetDate in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

testUpdateTabStatus

public void testUpdateTabStatus(AuthToken pAuthToken,
                                boolean pApproved,
                                long pUserID,
                                java.lang.String pTab,
                                long pAssetID,
                                java.util.Calendar pDate)
                         throws java.rmi.RemoteException

Specified by:: testUpdateTabStatus in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

testCreateCustomAccessSetting

public void testCreateCustomAccessSetting(AuthToken pAuthToken,
                                          java.lang.String pType,
                                          java.lang.String pRoleContextName,
                                          boolean pIsDefault)
                                   throws java.rmi.RemoteException,
                                          OpenAPIException

Specified by:: testCreateCustomAccessSetting in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

getAssetMaxID

public long getAssetMaxID()
                   throws java.rmi.RemoteException,
                          OpenAPIException

Specified by:: getAssetMaxID in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testThrowOpenAPIException

public void testThrowOpenAPIException()
                               throws java.rmi.RemoteException,
                                      OpenAPIException

Specified by:: testThrowOpenAPIException in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testSetSetting

public void testSetSetting(java.lang.String pSettingName,
                           java.lang.String pSettingValue)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Specified by:: testSetSetting in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testGetSettingValue

public java.lang.String testGetSettingValue(java.lang.String pSettingName)
                                     throws java.rmi.RemoteException,
                                            OpenAPIException

Specified by:: testGetSettingValue in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testSetProperty

public void testSetProperty(java.lang.String pPropName,
                            java.lang.String pPropValue)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Specified by:: testSetProperty in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testDeleteAsset

public void testDeleteAsset(AuthToken pAuthToken,
                            long pAssetId)
                     throws java.rmi.RemoteException,
                            OpenAPIException

Specified by:: testDeleteAsset in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testDeleteUser

public void testDeleteUser(AuthToken pAuthToken,
                           long pUserId)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Specified by:: testDeleteUser in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testDeleteProject

public void testDeleteProject(AuthToken pAuthToken,
                              long pProjectId)
                       throws java.rmi.RemoteException,
                              OpenAPIException

Specified by:: testDeleteProject in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testDeleteAssetType

public void testDeleteAssetType(AuthToken pAuthToken,
                                long pAssetId)
                         throws java.rmi.RemoteException,
                                OpenAPIException

Specified by:: testDeleteAssetType in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testRestartJobMonitor

public void testRestartJobMonitor()
                           throws java.rmi.RemoteException,
                                  OpenAPIException

Specified by:: testRestartJobMonitor in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testThrowImportExportException

public void testThrowImportExportException(boolean pImpExp)
                                    throws java.rmi.RemoteException,
                                           OpenAPIException,
                                           ImportExportException

Specified by:: testThrowImportExportException in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException; ImportExportException

testGetLicenseState

public boolean testGetLicenseState()
                            throws java.rmi.RemoteException,
                                   OpenAPIException

Specified by:: testGetLicenseState in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testDetermineDBPlatform

public java.lang.String testDetermineDBPlatform()
                                         throws java.rmi.RemoteException,
                                                OpenAPIException

Specified by:: testDetermineDBPlatform in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testSetLicenseState

public void testSetLicenseState(boolean pLicensed)
                         throws java.rmi.RemoteException,
                                OpenAPIException

Specified by:: testSetLicenseState in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testAcceptableValueListDelete

public void testAcceptableValueListDelete(AuthToken pAuthToken,
                                          long pID)
                                   throws java.rmi.RemoteException,
                                          OpenAPIException

Specified by:: testAcceptableValueListDelete in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testLogMessage

public void testLogMessage(java.lang.String pMessage)
                    throws java.rmi.RemoteException,
                           OpenAPIException

Specified by:: testLogMessage in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testExtractionResetDatabaseForProject

public void testExtractionResetDatabaseForProject(long pProjectID)
                                           throws java.rmi.RemoteException,
                                                  OpenAPIException

Specified by:: testExtractionResetDatabaseForProject in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testUpdateViewAssetSetting

public void testUpdateViewAssetSetting(boolean pRemove)
                                throws java.rmi.RemoteException,
                                       OpenAPIException

Specified by:: testUpdateViewAssetSetting in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testCleanupNonRunningJobs

public void testCleanupNonRunningJobs()
                               throws java.rmi.RemoteException,
                                      OpenAPIException

Specified by:: testCleanupNonRunningJobs in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testUpdateUserRole

public void testUpdateUserRole(long pUserID,
                               boolean pRemove)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Specified by:: testUpdateUserRole in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testUpdateProjectAdminRole

public void testUpdateProjectAdminRole(long pUserID,
                                       boolean pRemove)
                                throws java.rmi.RemoteException,
                                       OpenAPIException

Specified by:: testUpdateProjectAdminRole in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testClearDatabase

public void testClearDatabase()
                       throws java.rmi.RemoteException

Specified by:: testClearDatabase in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

sfidAddToAsset

public void sfidAddToAsset(AuthToken pAuthToken,
                           SFIDInfo pSFID,
                           long assetID)
                    throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Associates a new SFIDInfo object to the asset specified in the SFIDInfo

Specified by:: sfidAddToAsset in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.
Throws:: java.rmi.RemoteException

sfidRemoveAllFromAsset

public void sfidRemoveAllFromAsset(AuthToken pAuthToken,
                                   long assetID)
                            throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Remove all of the SFIDInfos associated with the specified asset

Specified by:: sfidRemoveAllFromAsset in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.; assetID - id of the asset from which to remove all of the SFIDInfos
Throws:: java.rmi.RemoteException

sfidUpdateAsset

public void sfidUpdateAsset(AuthToken pAuthToken,
                            SFIDInfo[] pSFIDs,
                            long assetID)
                     throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Remove all of the existing SFIDInfos associated with an asset, and replace them with the new list

Specified by:: sfidUpdateAsset in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.; pSFIDs - list of HashInfo objects to update
Throws:: java.rmi.RemoteException

sfidReadValuesByProject

public java.lang.String[] sfidReadValuesByProject(AuthToken pAuthToken,
                                                  long projectid)
                                           throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Get all of the SFID values from all of the assets extracted to the specified project

Specified by:: sfidReadValuesByProject in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.; projectid - id of the project
Returns:: String list of SFID values
Throws:: java.rmi.RemoteException

sfidQuery

public SFIDInfo[] sfidQuery(AuthToken pAuthToken,
                            SFIDCriteria pCrit)
                     throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Get all of the SFID values from all of the assets extracted to the specified project

Specified by:: sfidQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.
Returns:: String list of SFID values
Throws:: java.rmi.RemoteException

sfidCandidateQuery

public SFIDCandidate[] sfidCandidateQuery(AuthToken pAuthToken,
                                          SFIDCriteria pCrit)
                                   throws java.rmi.RemoteException

Specified by:: sfidCandidateQuery in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

sfidGenerate

public SFIDInfo[] sfidGenerate(AuthToken pAuthToken,
                               int pMethod)
                        throws java.rmi.RemoteException

Specified by:: sfidGenerate in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

sfidCandidateSubmit

public SFIDCandidate[] sfidCandidateSubmit(AuthToken pAuthToken,
                                           SFIDCandidate[] pCandidates)
                                    throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

This method submits a set of SFIDCandidates. The candidates will be stored for review and possible harvesting by a registrar. Note that NEW candidate records will only be created if candidate record does not already exist with the same:

sfid value
sfid algorithm
source (e.g., eclipse 3.0)
hostname
hostip
generating user

If a candidate is found in the system with the same attributes as one being submitted, the numSeen property will simply be incremented for the already existing record.

Specified by:: sfidCandidateSubmit in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.
Returns:: An array of SFIDCandidate array.
Throws:: java.rmi.RemoteException

sfidReadValuesForAsset

public java.lang.String[] sfidReadValuesForAsset(AuthToken pAuthToken,
                                                 long assetID)
                                          throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Get all of the hash values associated with the specified asset

Specified by:: sfidReadValuesForAsset in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user. Must have edit permission.; assetID - id of the asset used to query the hash values
Returns:: String list of SFID values
Throws:: java.rmi.RemoteException

sfidRegisterExtractionBySFIDValue

public void sfidRegisterExtractionBySFIDValue(AuthToken pAuthToken,
                                              long projectid,
                                              java.lang.String pSFID)
                                       throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Extract all assets with the following hash value to the specified project.

Specified by:: sfidRegisterExtractionBySFIDValue in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; projectid - id of the project to extract to; pSFID - SFID value used to find assets
Throws:: java.rmi.RemoteException

sfidRegisterExtractionBySFIDValues

public void sfidRegisterExtractionBySFIDValues(AuthToken pAuthToken,
                                               long projectid,
                                               java.lang.String[] pSFIDs)
                                        throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Extract all assets with any of the following hash values to the specified project

Specified by:: sfidRegisterExtractionBySFIDValues in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; projectid - id of the project to extract to; pSFIDs - list of hash values used to find assets
Throws:: java.rmi.RemoteException

sfidRegisterExtractionBySFIDCandidates

public AssetSummary[] sfidRegisterExtractionBySFIDCandidates(AuthToken pAuthToken,
                                                             long projectid,
                                                             SFIDCandidate[] pSFIDCandidates)
                                                      throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Extract all assets with any of the following hash values to the specified project and return an array of asset summaries for the extracted assets.

Specified by:: sfidRegisterExtractionBySFIDCandidates in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; projectid - id of the project to extract to; pSFIDCandidates - list of SFID Candidates
Returns:: list of asset summaries showing which assets were extracted
Throws:: java.rmi.RemoteException

sfidRegisterExtractionBySFIDCandidatesLite

public void sfidRegisterExtractionBySFIDCandidatesLite(AuthToken pAuthToken,
                                                       long projectid,
                                                       SFIDCandidate[] pSFIDCandidates)
                                                throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Extract all assets with any of the following hash values to the specified project without returning asset summaries for the extracted assets.

Specified by:: sfidRegisterExtractionBySFIDCandidatesLite in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; projectid - id of the project to extract to; pSFIDCandidates - list of SFID Candidates
Throws:: java.rmi.RemoteException

sfidRegisterExtractions

public void sfidRegisterExtractions(AuthToken pAuthToken,
                                    long pProjectID,
                                    SFIDCandidate[] pSFIDCandidates,
                                    boolean pHarvest)
                             throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Register usage of assets to a specified project by matching SFIDs to files that are associated with assets. If the parameter pHarvest is set to true, SFIDs that are NOT matched will be retained for harvesting operations by a registrar.

Specified by:: sfidRegisterExtractions in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pProjectID - the id of the project to which extraction should occur; pSFIDCandidates - list of SFID values for matching; pHarvest - if true, retain unmatched SFID candidates for harvesting operations by a registrar
Throws:: java.rmi.RemoteException

sfidRegisterExtractionBySFIDValuesResults

public AssetSummary[] sfidRegisterExtractionBySFIDValuesResults(AuthToken pAuthToken,
                                                                long projectid,
                                                                java.lang.String[] pSFIDs)
                                                         throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Extract all assets with any of the following hash values to the specified project

Specified by:: sfidRegisterExtractionBySFIDValuesResults in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; projectid - id of the project to extract to; pSFIDs - list of hash values used to find assets
Returns:: AssetSummary list of asset summaries showing which assets were extracted
Throws:: java.rmi.RemoteException

reuseDTORead

public ReuseDTO reuseDTORead()
                      throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

This method returns a composite object containing all the information required to display the reuse portlet.

Specified by:: reuseDTORead in interface FlashlineRegistry

Returns:: A ReuseDTO object
Throws:: java.rmi.RemoteException

assetMetadataCreateDIME

public void assetMetadataCreateDIME(AuthToken pAuthToken,
                                    MetadataEntrySummary pMetadataEntrySummary)
                             throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Creates the metadata entry specified and associates it with the specified asset. Actual payload is expected to be attached as a DIME attachment, the associated tags and descriptive text for the entry are also saved.

Specified by:: assetMetadataCreateDIME in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pMetadataEntrySummary - metadata entry summary object to update
Throws:: java.rmi.RemoteException

assetMetadataCreateSwA

public void assetMetadataCreateSwA(AuthToken pAuthToken,
                                   MetadataEntrySummary pMetadataEntrySummary)
                            throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Creates the metadata entry specified and associates it with the specified asset. Actual payload is expected to be attached as an SwA attachment, the associated tags and descriptive text for the entry are also saved.

Specified by:: assetMetadataCreateSwA in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pMetadataEntrySummary - metadata entry summary object to update
Throws:: java.rmi.RemoteException

assetMetadataRead

public MetadataEntrySummary[] assetMetadataRead(AuthToken pAuthToken,
                                                long pAssetID)
                                         throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Reads metadata entries associated with the given Asset. Actual payload is not included in the read, just associated tags and descriptive text.

Specified by:: assetMetadataRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pAssetID - id of Asset to load metadata for.
Returns:: array of MetadataEntrySummary objects for given asset
Throws:: java.rmi.RemoteException

assetMetadataReadDIME

public MetadataEntrySummary[] assetMetadataReadDIME(AuthToken pAuthToken,
                                                    long pAssetID)
                                             throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Reads metadata entries associated with the given Asset. Actual payload is included as a DIME attachment, as well as associated tags and descriptive text.

Specified by:: assetMetadataReadDIME in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pAssetID - id of Asset to load metadata for.
Returns:: array of MetadataEntrySummary objects for given asset, attachment(s) containing actual data
Throws:: java.rmi.RemoteException

assetMetadataReadSwA

public MetadataEntrySummary[] assetMetadataReadSwA(AuthToken pAuthToken,
                                                   long pAssetID)
                                            throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Reads metadata entries associated with the given Asset. Actual payload is included as an SwA attachment, as well as associated tags and descriptive text.

Specified by:: assetMetadataReadSwA in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pAssetID - id of Asset to load metadata for.
Returns:: array of MetadataEntrySummary objects for given asset, attachment(s) containing actual data
Throws:: java.rmi.RemoteException

assetMetadataUpdate

public void assetMetadataUpdate(AuthToken pAuthToken,
                                MetadataEntrySummary pMetadataEntrySummary)
                         throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Updates metadata entry specified. Actual payload is not expected to be attached, this just updates the just associated tags and descriptive text for the entry.

Specified by:: assetMetadataUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pMetadataEntrySummary - metadata entry summary object to update
Throws:: java.rmi.RemoteException

assetMetadataUpdateDIME

public void assetMetadataUpdateDIME(AuthToken pAuthToken,
                                    MetadataEntrySummary pMetadataEntrySummary)
                             throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Updates metadata entry specified. Actual payload is expected to be attached as a DIME attachment, the associated tags and descriptive text for the entry are also updated.

Specified by:: assetMetadataUpdateDIME in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pMetadataEntrySummary - metadata entry summary object to update
Throws:: java.rmi.RemoteException

assetMetadataUpdateSwA

public void assetMetadataUpdateSwA(AuthToken pAuthToken,
                                   long pAssetID,
                                   MetadataEntrySummary pMetadataEntrySummary)
                            throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Updates metadata entry specified. Actual payload is expected to be attached as an SwA attachment, the associated tags and descriptive text for the entry are also updated.

Specified by:: assetMetadataUpdateSwA in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pMetadataEntrySummary - metadata entry summary object to update
Throws:: java.rmi.RemoteException

assetMetadataEntryDelete

public void assetMetadataEntryDelete(AuthToken pAuthToken,
                                     long pMetadataEntryID)
                              throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Deletes the specified metadata entry and disassociates it from its parent Asset.

Specified by:: assetMetadataEntryDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user.; pMetadataEntryID - metadata entry id to delete
Throws:: java.rmi.RemoteException

assetMetadataAccept

public void assetMetadataAccept(AuthToken pAuthToken,
                                MetadataEntrySummary pMetadataEntrySummary)
                         throws java.rmi.RemoteException

Specified by:: assetMetadataAccept in interface FlashlineRegistry

pMetadataEntrySummary - Metadata Entry Summary
Throws:: java.rmi.RemoteException

metadataEntryTypeCreate

public MetadataEntryTypeSummary metadataEntryTypeCreate(AuthToken pAuthToken,
                                                        java.lang.String pName)
                                                 throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Creates a new metadata entry type.

Specified by:: metadataEntryTypeCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pName - the name of the new MetadataEntryType
Returns:: the newly created MetadataEntryType object
Throws:: java.rmi.RemoteException

metadataEntryTypeRead

public MetadataEntryTypeSummary metadataEntryTypeRead(AuthToken pAuthToken,
                                                      long pID)
                                               throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Reads a metadata entry type by ID.

Specified by:: metadataEntryTypeRead in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - the ID of the metadata entry type to read
Returns:: the requested metadata entry type object
Throws:: java.rmi.RemoteException

metadataEntryTypeUpdate

public MetadataEntryTypeSummary metadataEntryTypeUpdate(AuthToken pAuthToken,
                                                        MetadataEntryTypeSummary pMetadataEntryType)
                                                 throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Updates a metadata entry type.

Specified by:: metadataEntryTypeUpdate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pMetadataEntryType - the modified metadata entry type object to be saved
Returns:: the metadata entry type object after the modifications have been saved
Throws:: java.rmi.RemoteException

metadataEntryTypeDelete

public void metadataEntryTypeDelete(AuthToken pAuthToken,
                                    long pID)
                             throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Deletes a metadata entry type.

Specified by:: metadataEntryTypeDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - the unique ID of the metadata entry type to be deleted
Throws:: java.rmi.RemoteException

metadataEntryTypeQuery

public MetadataEntryTypeSummary[] metadataEntryTypeQuery(AuthToken pAuthToken,
                                                         MetadataEntryTypeCriteria pQuery)
                                                  throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Searches for all metadata entry types whose names contain the specified criteria. Valid criteria includes the metadata entry type name as a String. Case is ignored.

Specified by:: metadataEntryTypeQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pQuery - a criteria object containing the name of the metadata entry type for which to search
Returns:: an array of metadata entry type objects matching the criteria, or an empty array if no metadata entry types match
Throws:: java.rmi.RemoteException

metadataEntryCreateDIME

public MetadataEntrySummary metadataEntryCreateDIME(AuthToken pAuthToken,
                                                    MetadataEntrySummary pMetadataEntrySummary)
                                             throws java.rmi.RemoteException,
                                                    OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new metadata entry. Actual payload is expected to be attached as a DIME attachment, the associated tags and descriptive text for the entry are also saved.

Specified by:: metadataEntryCreateDIME in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pMetadataEntrySummary - the new metadata-entry object to create
Returns:: the newly created metadata-entry object
Throws:: OpenAPIException - when there is a problem creating the MetadataEntry; java.rmi.RemoteException

metadataEntryCreateSwA

public MetadataEntrySummary metadataEntryCreateSwA(AuthToken pAuthToken,
                                                   MetadataEntrySummary pMetadataEntrySummary)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Creates a new metadata entry. Actual payload is expected to be attached as an SwA attachment, the associated tags and descriptive text for the entry are also saved.

Specified by:: metadataEntryCreateSwA in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pMetadataEntrySummary - the new metadata-entry object to create
Returns:: the newly created metadata-entry object
Throws:: OpenAPIException - when there is a problem creating the MetadataEntry; java.rmi.RemoteException

metadataEntryReadDIME

public MetadataEntrySummary metadataEntryReadDIME(AuthToken pAuthToken,
                                                  EntityUUID pEntityUUID)
                                           throws java.rmi.RemoteException,
                                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Reads a metadata-entry by UUID. Actual payload is included as a DIME attachment, as well as associated tags and descriptive text.

Specified by:: metadataEntryReadDIME in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pEntityUUID - the UUID of the metadata-entry to read
Returns:: the requested metadata-entry object
Throws:: OpenAPIException - when there is a problem reading the MetadataEntry; java.rmi.RemoteException

metadataEntryReadDIME

public MetadataEntrySummary metadataEntryReadDIME(AuthToken pAuthToken,
                                                  long pID)
                                           throws java.rmi.RemoteException,
                                                  OpenAPIException

Description copied from interface: FlashlineRegistry

Reads a metadata-entry by ID. Actual payload is included as an SwA attachment, as well as associated tags and descriptive text.

Specified by:: metadataEntryReadDIME in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - the ID of the metadata-entry to read
Returns:: the requested metadata-entry object
Throws:: OpenAPIException - when there is a problem reading the MetadataEntry; java.rmi.RemoteException

metadataEntryReadSwA

public MetadataEntrySummary metadataEntryReadSwA(AuthToken pAuthToken,
                                                 EntityUUID pEntityUUID)
                                          throws java.rmi.RemoteException,
                                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Reads a metadata-entry by UUID. Actual payload is included as an SwA attachment, as well as associated tags and descriptive text.

Specified by:: metadataEntryReadSwA in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pEntityUUID - the UUID of the metadata-entry to read
Returns:: the requested metadata-entry object
Throws:: OpenAPIException - when there is a problem reading the MetadataEntry; java.rmi.RemoteException

metadataEntryReadSwA

public MetadataEntrySummary metadataEntryReadSwA(AuthToken pAuthToken,
                                                 long pID)
                                          throws java.rmi.RemoteException,
                                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Reads a metadata-entry by ID. Actual payload is included as an SwA attachment, as well as associated tags and descriptive text.

Specified by:: metadataEntryReadSwA in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pID - the ID of the metadata-entry to read
Returns:: the requested metadata-entry object
Throws:: OpenAPIException - when there is a problem reading the MetadataEntry; java.rmi.RemoteException

metadataEntryUpdateDIME

public MetadataEntrySummary metadataEntryUpdateDIME(AuthToken pAuthToken,
                                                    MetadataEntrySummary pMetadataEntrySummary)
                                             throws java.rmi.RemoteException,
                                                    OpenAPIException

Description copied from interface: FlashlineRegistry

Updates a metadata-entry. Actual payload is expected to be attached as a DIME attachment, the associated tags and descriptive text for the entry are also saved.

Specified by:: metadataEntryUpdateDIME in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pMetadataEntrySummary - the modified metadata-entry object to be saved
Returns:: the metadata-entry object after the modifications have been saved
Throws:: OpenAPIException - when there is a problem updating the MetadataEntry; java.rmi.RemoteException

metadataEntryUpdateSwA

public MetadataEntrySummary metadataEntryUpdateSwA(AuthToken pAuthToken,
                                                   MetadataEntrySummary pMetadataEntrySummary)
                                            throws java.rmi.RemoteException,
                                                   OpenAPIException

Description copied from interface: FlashlineRegistry

Updates a metadata-entry. Actual payload is expected to be attached as an SwA attachment, the associated tags and descriptive text for the entry are also saved.

Specified by:: metadataEntryUpdateSwA in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pMetadataEntrySummary - the modified metadata-entry object to be saved
Returns:: the metadata-entry object after the modifications have been saved
Throws:: OpenAPIException - when there is a problem updating the MetadataEntry; java.rmi.RemoteException

metadataEntryDelete

public void metadataEntryDelete(AuthToken pAuthToken,
                                EntityUUID pEntityUUID)
                         throws java.rmi.RemoteException,
                                OpenAPIException

Description copied from interface: FlashlineRegistry

Deletes a metadata-entry.

Specified by:: metadataEntryDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pEntityUUID - the UUID of the metadata-entry to be deleted
Throws:: OpenAPIException - when there is a problem deleting the MetadataEntry; java.rmi.RemoteException

metadataEntryQuery

public MetadataEntrySummary[] metadataEntryQuery(AuthToken pAuthToken,
                                                 MetadataEntryCriteria pQuery)
                                          throws java.rmi.RemoteException,
                                                 OpenAPIException

Description copied from interface: FlashlineRegistry

Searches for metadata-entries by entry type or associated entity.

Specified by:: metadataEntryQuery in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pQuery - a criteria object containing the terms of the metadata-entry for which to search
Returns:: an array of metadata-entry objects matching the criteria, or an empty array if no metadata-entries match
Throws:: OpenAPIException - when there is a problem finding MetadataEntries; java.rmi.RemoteException

testCasDelete

public void testCasDelete(AuthToken pAuthToken,
                          java.lang.String pCasName)
                   throws java.rmi.RemoteException,
                          OpenAPIException

Specified by:: testCasDelete in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testCasCreate

public void testCasCreate(AuthToken pAuthToken,
                          java.lang.String pCasName,
                          java.lang.String pCasType)
                   throws java.rmi.RemoteException,
                          OpenAPIException

Specified by:: testCasCreate in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testRoleContextAddRole

public void testRoleContextAddRole(AuthToken pAuthToken,
                                   java.lang.String pRoleContextName,
                                   java.lang.String pRoleName,
                                   java.lang.String pRoleOperator)
                            throws java.rmi.RemoteException,
                                   OpenAPIException

Specified by:: testRoleContextAddRole in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testRoleContextSetPermission

public void testRoleContextSetPermission(AuthToken pAuthToken,
                                         java.lang.String pRoleContextName,
                                         java.lang.String pRoleName,
                                         java.lang.String pRoleOperator,
                                         PermissionValue pPermissionValueBean)
                                  throws java.rmi.RemoteException,
                                         OpenAPIException

Specified by:: testRoleContextSetPermission in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testRoleContextSetPermissions

public void testRoleContextSetPermissions(AuthToken pAuthToken,
                                          java.lang.String pRoleContextName,
                                          java.lang.String pRoleName,
                                          java.lang.String pRoleOperator,
                                          PermissionValue[] pPermssionValueBeans)
                                   throws java.rmi.RemoteException,
                                          OpenAPIException

Specified by:: testRoleContextSetPermissions in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testRoleContextApplySecuritySettingToExisting

public void testRoleContextApplySecuritySettingToExisting(AuthToken pAuthToken,
                                                          java.lang.String pRoleContextName)
                                                   throws java.rmi.RemoteException

Specified by:: testRoleContextApplySecuritySettingToExisting in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

testRoleContextGetAllRoles

public java.lang.String[] testRoleContextGetAllRoles(AuthToken pAuthToken,
                                                     java.lang.String pRoleContextName)
                                              throws java.rmi.RemoteException

Specified by:: testRoleContextGetAllRoles in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

testRoleContextGetPermissionFromRole

public java.lang.String testRoleContextGetPermissionFromRole(AuthToken pAuthToken,
                                                             java.lang.String pRoleContextName,
                                                             java.lang.String pPermissionName,
                                                             java.lang.String pRoleName,
                                                             java.lang.String pRoleOperator)
                                                      throws java.rmi.RemoteException

Specified by:: testRoleContextGetPermissionFromRole in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

testRoleContextClearRoles

public void testRoleContextClearRoles(AuthToken pAuthToken,
                                      java.lang.String pRoleContextName)
                               throws java.rmi.RemoteException

Specified by:: testRoleContextClearRoles in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

testRoleContextRemoveRole

public void testRoleContextRemoveRole(AuthToken pAuthToken,
                                      java.lang.String pRoleContextName,
                                      java.lang.String pRoleName,
                                      java.lang.String pRoleOperator)
                               throws java.rmi.RemoteException,
                                      OpenAPIException

Specified by:: testRoleContextRemoveRole in interface FlashlineRegistry

Throws:: java.rmi.RemoteException; OpenAPIException

testDoSQL

public int testDoSQL(java.lang.String pSQL)
              throws java.rmi.RemoteException

Specified by:: testDoSQL in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

testHasSufficientAssets

public boolean testHasSufficientAssets()
                                throws java.rmi.RemoteException

Specified by:: testHasSufficientAssets in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

testDoSimpleQuery

public java.lang.String[] testDoSimpleQuery(java.lang.String[] pArgs,
                                            java.lang.String pColumnName,
                                            java.lang.String pQuery)
                                     throws java.rmi.RemoteException

Description copied from interface: FlashlineRegistry

Create a subscription for the user identified by pAuthToken to the assets listed in pAssetIDs. User will be added to the subscription list for emails sent as a result of raised system events. If pFailOnAnyError is true, then the entire subscription request will fail if for any reason any asset fails in its subscription request. These failures could include RBAC access restrictions for assets listed in pAssetIDs.

Specified by:: testDoSimpleQuery in interface FlashlineRegistry

Throws:: java.rmi.RemoteException

subscriptionCreate

public void subscriptionCreate(AuthToken pAuthToken,
                               long[] pAssetIDs,
                               boolean pFailOnAnyError)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Description copied from interface: FlashlineRegistry

Specified by:: subscriptionCreate in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pAssetIDs - the list of asset IDs for which to subscribe the user; pFailOnAnyError - if true, fail the entire subscription request if ANY error occurs on any asset listed in pAssetIDs
Throws:: java.rmi.RemoteException; OpenAPIException

subscriptionDelete

public void subscriptionDelete(AuthToken pAuthToken,
                               long[] pAssetIDs)
                        throws java.rmi.RemoteException,
                               OpenAPIException

Description copied from interface: FlashlineRegistry

Delete an existing subscription for the user identified by pAuthToken to the assets listed in pAssetIDs. If the user does not currently have subscriptions to assets listed in pAssetIDs, no subscription will be removed for that asset, and no error will be thrown.

Specified by:: subscriptionDelete in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user; pAssetIDs - the list of asset IDs for which to unsubscribe the user
Throws:: java.rmi.RemoteException; OpenAPIException

subscriptionReadSubscribedAssets

public long[] subscriptionReadSubscribedAssets(AuthToken pAuthToken)
                                        throws java.rmi.RemoteException,
                                               OpenAPIException

Description copied from interface: FlashlineRegistry

Retrieve the list of assets to which the user identified by pAuthToken is subscribed.

Specified by:: subscriptionReadSubscribedAssets in interface FlashlineRegistry

Parameters:: pAuthToken - authtoken against which to validate the user
Returns:: list of assets to which the user identified by pAuthToken is subscribed.
Throws:: OpenAPIException; java.rmi.RemoteException

subscriptionReadUsersSubscribedToAsset

public RegistryUser[] subscriptionReadUsersSubscribedToAsset(AuthToken pAuthTokenBean,
                                                             long pAssetID)
                                                      throws java.rmi.RemoteException,
                                                             OpenAPIException

Description copied from interface: FlashlineRegistry

Return all of the users subscribed to an asset. The user must have the privilege to VIEW user information in order to see users other than themself.

Specified by:: subscriptionReadUsersSubscribedToAsset in interface FlashlineRegistry

pAssetID - the asset id for which to determine subscribed users
Returns:: an array of subscribed users
Throws:: OpenAPIException - if something goes wrong; java.rmi.RemoteException

retrieveRootArtifacts

public Asset[] retrieveRootArtifacts(AuthToken pAuthToken,
                                     long pAbstractAssetId)
                              throws java.rmi.RemoteException,
                                     OpenAPIException

Description copied from interface: FlashlineRegistry

This method retrieves a set of Assets corresponding to roots of collections of related artifact assets which are directly connected to the passed abstract asset (i.e. asset representing a service, bpel, interface, endpoint or xslt). The assets are ordered by date of introspection in descending order (i.e. the most recent introspection is at position 0). Also, root assets for which the user does not have access to the entire subgraph are automatically filtered out.

Specified by:: retrieveRootArtifacts in interface FlashlineRegistry

Parameters:: pAuthToken - The auth token associated with the user login; pAbstractAssetId - The ID of the "abstract" asset described above
Returns:: A list of assets, sorted inverse chronologically by introspection date
Throws:: OpenAPIException; java.rmi.RemoteException

retrieveLatestRootArtifact

public Asset retrieveLatestRootArtifact(AuthToken pAuthToken,
                                        long pAbstractAssetId)
                                 throws java.rmi.RemoteException,
                                        OpenAPIException

Description copied from interface: FlashlineRegistry

This method retrieves a the Asset corresponding to the latest introspected root of collections of related artifact assets which are directly connected to the passed abstract asset (i.e. asset representing a service, bpel, interface, endpoint or xslt).

Specified by:: retrieveLatestRootArtifact in interface FlashlineRegistry

Parameters:: pAuthToken - The auth token associated with the user login; pAbstractAssetId - The ID of the "abstract" asset described above
Returns:: An asset associated with the latest introspection chronologically which created an artifact graph or null, if none exist (or can be seen).
Throws:: OpenAPIException; java.rmi.RemoteException

retrieveArtifactCollectionAsDIME

public void retrieveArtifactCollectionAsDIME(AuthToken pAuthToken,
                                             long pAbstractAssetId,
                                             long pArtifactRootId)
                                      throws java.rmi.RemoteException,
                                             OpenAPIException

Description copied from interface: FlashlineRegistry

This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root. It uses DIME for the attachment.

Specified by:: retrieveArtifactCollectionAsDIME in interface FlashlineRegistry

Parameters:: pAuthToken - The auth token associated with the user login; pAbstractAssetId - The ID of the "abstract" asset described above; pArtifactRootId - The ID of the root of the artifact graph .
Throws:: OpenAPIException; java.rmi.RemoteException

retrieveAndRecordUsageOfArtifactCollectionAsDIME

public void retrieveAndRecordUsageOfArtifactCollectionAsDIME(AuthToken pAuthToken,
                                                             long pAbstractAssetId,
                                                             long pArtifactRootId,
                                                             long pProjectId,
                                                             RegistryUser pRbacRegistrySecUserBean)
                                                      throws java.rmi.RemoteException,
                                                             OpenAPIException

Description copied from interface: FlashlineRegistry

This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root. It uses DIME for the attachment. It will record usage for all assets in the zip bundle. Usage will be assigned to the user associated with the auth token.

Specified by:: retrieveAndRecordUsageOfArtifactCollectionAsDIME in interface FlashlineRegistry

Parameters:: pAuthToken - The auth token associated with the user login; pAbstractAssetId - The ID of the "abstract" asset described above; pArtifactRootId - The ID of the root of the artifact graph .; pProjectId - The ID of the project to record usage to.
Throws:: OpenAPIException; java.rmi.RemoteException

retrieveAndRecordUsageOfArtifactCollectionAsDIME

public void retrieveAndRecordUsageOfArtifactCollectionAsDIME(AuthToken pAuthToken,
                                                             long pAbstractAssetId,
                                                             long pArtifactRootId,
                                                             long pProjectId)
                                                      throws java.rmi.RemoteException,
                                                             OpenAPIException

Description copied from interface: FlashlineRegistry

Specified by:: retrieveAndRecordUsageOfArtifactCollectionAsDIME in interface FlashlineRegistry

Parameters:: pAuthToken - The auth token associated with the user login; pAbstractAssetId - The ID of the "abstract" asset described above; pArtifactRootId - The ID of the root of the artifact graph .; pProjectId - The ID of the project to record usage to.
Throws:: OpenAPIException; java.rmi.RemoteException

retrieveArtifactCollectionAsSwa

public void retrieveArtifactCollectionAsSwa(AuthToken pAuthToken,
                                            long pAbstractAssetId,
                                            long pArtifactRootId)
                                     throws java.rmi.RemoteException,
                                            OpenAPIException

Description copied from interface: FlashlineRegistry

This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root. It uses SWA for the attachment.

Specified by:: retrieveArtifactCollectionAsSwa in interface FlashlineRegistry

Parameters:: pAuthToken - The auth token associated with the user login; pAbstractAssetId - The ID of the "abstract" asset described above; pArtifactRootId - The ID of the root of the artifact graph .
Throws:: OpenAPIException; java.rmi.RemoteException

retrieveAndRecordUsageOfArtifactCollectionAsSwa

public void retrieveAndRecordUsageOfArtifactCollectionAsSwa(AuthToken pAuthToken,
                                                            long pAbstractAssetId,
                                                            long pArtifactRootId,
                                                            long pProjectId,
                                                            RegistryUser pRbacRegistrySecUserBean)
                                                     throws java.rmi.RemoteException,
                                                            OpenAPIException

Description copied from interface: FlashlineRegistry

This method attaches the payload of the associated zip bundle of the artifact collection associated with the given abstract asset and artifact root. It uses SWA for the attachment. It will record usage for all assets in the zip bundle. Usage will be assigned to the user associated with the auth token.

Specified by:: retrieveAndRecordUsageOfArtifactCollectionAsSwa in interface FlashlineRegistry

Parameters:: pAuthToken - The auth token associated with the user login; pAbstractAssetId - The ID of the "abstract" asset described above; pArtifactRootId - The ID of the root of the artifact graph .; pProjectId - The ID of the project to record usage to.
Throws:: OpenAPIException; java.rmi.RemoteException

retrieveAndRecordUsageOfArtifactCollectionAsSwa

public void retrieveAndRecordUsageOfArtifactCollectionAsSwa(AuthToken pAuthToken,
                                                            long pAbstractAssetId,
                                                            long pArtifactRootId,
                                                            long pProjectId)
                                                     throws java.rmi.RemoteException,
                                                            OpenAPIException

Description copied from interface: FlashlineRegistry

Specified by:: retrieveAndRecordUsageOfArtifactCollectionAsSwa in interface FlashlineRegistry

Parameters:: pAuthToken - The auth token associated with the user login; pAbstractAssetId - The ID of the "abstract" asset described above; pArtifactRootId - The ID of the root of the artifact graph .; pProjectId - The ID of the project to record usage to.
Throws:: OpenAPIException; java.rmi.RemoteException

getLatestArtifacts

public FileInfo[] getLatestArtifacts(AuthToken pAuthToken,
                                     long pAbstractAssetId,
                                     boolean pIsService)
                              throws java.rmi.RemoteException,
                                     OpenAPIException

Description copied from interface: FlashlineRegistry

This is a convenience method to ease retrieving artifacts associated with abstract assets in the post-3.0 ALER model. Specifically, this method will return an array of FileInfos which correspond to artifacts (e.g. an Artifact:WSDL) at the root of the artifact graph associated with an abstract asset (e.g. an Interface). In most cases, this will return an array of one item. The exception to this is for the case where the abstract asset ID corresponds to a service (and, consequently, pIsService is set to true). In this case, we follow the relationship between the service to each of its endpoints and, for each endpoint, return the FileInfo associated with the artifact WSDL which was most recently introspected.

Specified by:: getLatestArtifacts in interface FlashlineRegistry

pIsService - If set to true, traverse the relationship between the Service to the Endpoint first and, for each endpoint, return the latest FileInfo at the root of the artifact graph.
Returns:
Throws:: OpenAPIException; java.rmi.RemoteException

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle© Fusion Middleware Extensibility Framework (REX) for Oracle Enterprise Repository
11g Release 1 (11.1.1)
E16598-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.flashline.registry.openapi.service.v300 Class FlashlineRegistrySoapBindingStub

FlashlineRegistrySoapBindingStub

FlashlineRegistrySoapBindingStub

FlashlineRegistrySoapBindingStub

createCall

assetTypeTabsRead

assetTabApprove

assetTabUnapprove

notificationCreate

notificationSubstitutionsRead

artifactStoreQuery

authTokenCreate

authTokenCreateWithLicense

authTokenDelete

authTokenValidate

assetCreate

assetCreateFromXML

assetRead

assetReadXml

assetReadCustomDataString

assetReadCustomDataNode

assetReadArray

assetReadArrayFromSummary

assetUpdate

assetGetUnacceptedFiles

assetAcceptFiles

assetUpdateCustomDataString

assetUpdateCustomDataStringArray

assetUpdateCustomDataNode

assetUpdateCustomDataNodeFromStringArray

assetUploadFiles

assetAddRegistrarNote

assetReadRegistrarNotes

assetRegister

assetUnRegister

assetAccept

assetUnAccept

assetSubmit

assetUnSubmit

assetActivate

assetDeactivate

assetRetire

assetDelete

assetTabsRead

assetTabRead

assetQuerySummary

assetQuery

assetQueryCount

assetReadAppliedToProjects

assetReadAppliedPolicies

assetUpdateAppliedPolicies

assetEvaluate

assetEvaluateAgainstAllPolicies

assetEvaluateAgainstPolicy

assetApplyToProjects

assetRemoveAppliedToProjects

repositoryFileTranslator

categorizationTypeCreate

categorizationTypeRead

categorizationTypeUpdate

categorizationTypeDelete

categorizationTypeQuery

categorizationCreate

categorizationChildCreate

categorizationRead

categorizationReadByType

categorizationChildRead

categorizationUpdate

categorizationUpdateArray

categorizationDeactivate

categorizationReactivate

contactCreate

contactRead

contactUpdate

contactDelete

contactQuery

extractionCreate

extractionGetHiddenAssetUsers

extractionCreateForUser

extractionTentativelyAccept

com.flashline.registry.openapi.service.v300
Class FlashlineRegistrySoapBindingStub