Package com.ibm.dbb.metadata
Interface Collection
-
- All Superinterfaces:
ManagedObject
,MetadataObject
,com.ibm.dbb.metadata.common.MetadataStoreConstants
public interface Collection extends ManagedObject
The Collection is a metadata object that stores logical files. Logical files contain source file and dependency metadata produced from scanning files and load modules.As of release 2.0.2, Collections are contained within a
BuildGroup
. To create, delete, and copy collections within and between build groups, use the appropriateBuildGroup
methods for doing so.
-
-
Field Summary
-
Fields inherited from interface com.ibm.dbb.metadata.common.MetadataStoreConstants
AMPERSAND, AND, APPLICATION_JSON, ARTIFACT, ASC, ATTACHMENT, ATTACHMENTS, BASIC_AUTHENTICATION, BRANCH, BUILD, BUILD_REPORT, BUILD_REPORT_DATA, BUILD_RESULT, CATEGORY, CICS, COLLECTION, COMMA, CONTENT, CONTENT_TYPE, CREATED, CREATED_BY, DATASET, DATE, DEFAULT_GROUP, DEFAULT_SSL_PROTOCOLS, DEPLOY_TYPE, DESC, DLI, EQUALS, FILE, FORM_AUTHENTICATION, GROUP, GROUPS, ID, IMPACT_FILES, LABEL, LABELS, LANGUAGE, LAST_UPDATED, LAST_UPDATED_BY, LD_PREFIX, LIBRARY, LNAME, LOG, LOGICAL_DEPENDENCIES, LOGICAL_FILE, MEMBER, MINIMAL, MQ, NAME, ORDER, ORDER_BY, OWNER, PATH, PERMISSION, PROPERTIES, PROPERTY, QUESTION_MARK, QUOTE, REST, SELF, SIZE, SLASH, SOURCE, SPACE, SQL, STATE, STATUS, TEAM, TEXT_HTML, TYPE, VALUE, VERSION
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addLogicalFile(LogicalFile lfile)
Convenient method to save a logical file to the repositoryvoid
addLogicalFiles(java.util.List<LogicalFile> lfiles)
Save a list of logical filesCollection
copy(java.lang.String newName)
Create a copy of this collection with the specified name within the same build groupboolean
deleteLogicalFile(java.lang.String file)
Delete a logical file for a given source filejava.lang.String
getGroup()
Get the build group of the collectionLogicalFile
getLogicalFile(java.lang.String file)
Return a logical file for a source filejava.util.List<LogicalFile>
getLogicalFiles()
Get a list of all logical files in a Collectionjava.util.List<LogicalFile>
getLogicalFiles(LogicalDependency logicalDependency)
Get all logical files that have a dependency which matches the provided logical dependencyjava.util.List<LogicalFile>
getLogicalFiles(java.lang.String logicalName)
Return a list of logical files for a programjava.lang.String
getName()
Return the name of the Collectionvoid
setName(java.lang.String name)
Set the name of the Collection-
Methods inherited from interface com.ibm.dbb.metadata.ManagedObject
getOwner, getPermission, getTeam, setOwner, setPermission, setTeam
-
Methods inherited from interface com.ibm.dbb.metadata.MetadataObject
getCreated, getCreatedBy, getLastUpdated, getLastUpdatedBy, toJSON, toString
-
-
-
-
Method Detail
-
copy
Collection copy(java.lang.String newName) throws BuildException
Create a copy of this collection with the specified name within the same build group- Parameters:
newName
- Name of new collection- Returns:
- new collection
- Throws:
BuildException
- an exception occurred
-
getName
java.lang.String getName()
Return the name of the Collection- Returns:
- the name
-
setName
void setName(java.lang.String name) throws BuildException
Set the name of the Collection- Parameters:
name
- the name of the collection- Throws:
BuildException
-
getGroup
java.lang.String getGroup() throws BuildException
Get the build group of the collection- Returns:
- Throws:
BuildException
-
getLogicalFile
LogicalFile getLogicalFile(java.lang.String file) throws BuildException
Return a logical file for a source file- Parameters:
file
- optional source file- Returns:
- the logical file
- Throws:
BuildException
- an exception occurred
-
getLogicalFiles
java.util.List<LogicalFile> getLogicalFiles(java.lang.String logicalName) throws BuildException
Return a list of logical files for a program- Parameters:
logicalName
- the name of the program- Returns:
- the list of logical files matching provided logical name
- Throws:
BuildException
- an exception occurred
-
getLogicalFiles
java.util.List<LogicalFile> getLogicalFiles(LogicalDependency logicalDependency) throws BuildException
Get all logical files that have a dependency which matches the provided logical dependency- Parameters:
logicalDependency
- the logical dependency whose criteria is used to find matching dependencies. Null fields are not used for matching.- Returns:
- the list of matching logical files
- Throws:
BuildException
- an exception occurred
-
getLogicalFiles
java.util.List<LogicalFile> getLogicalFiles() throws BuildException
Get a list of all logical files in a Collection- Returns:
- the list of logical files
- Throws:
BuildException
- an exception occurred
-
deleteLogicalFile
boolean deleteLogicalFile(java.lang.String file) throws BuildException
Delete a logical file for a given source file- Parameters:
file
- the source file- Returns:
- true if deleted
- Throws:
BuildException
- an exception occurred
-
addLogicalFile
void addLogicalFile(LogicalFile lfile) throws BuildException
Convenient method to save a logical file to the repository- Parameters:
lfile
- the logical file- Throws:
BuildException
- an exception occurred
-
addLogicalFiles
void addLogicalFiles(java.util.List<LogicalFile> lfiles) throws BuildException
Save a list of logical files- Parameters:
lfiles
- the list of logical files- Throws:
BuildException
- an exception occurred
-
-