public interface DictionaryService
Modifier and Type | Method and Description |
---|---|
String |
exportDictionaryToDataSet(String dictionaryId,
EntityStatus dictionaryStatus,
String version,
ExportFileCreateInfo info)
Exports a dictionary to a location in the repository or your workspace.
|
DictionaryDescriptor |
getDictionaryDescriptorByNameAndStatus(String name,
EntityStatus status)
Gets dictionary descriptor by name and
EntityStatus . |
Set<DictionaryDescriptor> |
getDictionaryDescriptorsByStatus(EntityStatus status)
Gets dictionary descriptors by
EntityStatus . |
Set<DictionaryDescriptor> getDictionaryDescriptorsByStatus(EntityStatus status)
EntityStatus
. If you do not have the Manage Standards global privilege,
only dictionaries with a PUBLISHED status will be returned.status
- The EntityStatus
of the dictionary.String exportDictionaryToDataSet(String dictionaryId, EntityStatus dictionaryStatus, String version, ExportFileCreateInfo info) throws DictionaryNotFoundException, ExportException
dictionaryId
- The identifier of the dictionary.dictionaryStatus
- The EntityStatus
of the dictionary.version
- (optional) The version of the published dictionary to export. The default version is the latest.
If version is provided, status is ignored as only published versions can be exported.info
- The method to add the exported data set.DictionaryNotFoundException
- Thrown when the dictionary does not exist.ExportException
- Thrown when there is an issue exporting the dictionary.DictionaryDescriptor getDictionaryDescriptorByNameAndStatus(String name, EntityStatus status) throws DictionaryNotFoundException
EntityStatus
. If EntityStatus is Published, the latest version is
returned. To get a dictionary with a status other than Published, the
GlobalPrivileges.PRIVILEGE_MANAGE_STANDARDS
privilege is required.name
- The name of the dictionary.status
- The EntityStatus
of the dictionary.DictionaryNotFoundException
- Thrown when the dictionary does not exist.Copyright (c) 2019, SAS Institute Inc., Cary, NC, USA