public interface Collection extends ManagedObject
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 appropriate BuildGroup
methods for doing so.
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_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, 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
Modifier and Type | Method and Description |
---|---|
void |
addLogicalFile(LogicalFile lfile)
Convenient method to save a logical file to the repository
|
void |
addLogicalFiles(java.util.List<LogicalFile> lfiles)
Save a list of logical files
|
Collection |
copy(java.lang.String newName)
Create a copy of this collection with the specified name within the same build group
|
void |
deleteLogicalFile(java.lang.String file)
Delete a logical file for a given source file
|
java.lang.String |
getGroup()
Get the build group of the collection
|
LogicalFile |
getLogicalFile(java.lang.String file)
Return a logical file for a source file
|
java.util.List<LogicalFile> |
getLogicalFiles()
Get a list of all logical files in a Collection
|
java.util.List<LogicalFile> |
getLogicalFiles(LogicalDependency logicalDependency)
Get all logical files that match a given logical dependency
|
java.util.List<LogicalFile> |
getLogicalFiles(java.lang.String logicalName)
Return a list of logical files for a program
|
java.lang.String |
getName()
Return the name of the Collection
|
void |
setName(java.lang.String name)
Set the name of the Collection
|
getOwner, getPermission, getTeam, setOwner, setPermission, setTeam
getCreated, getCreatedBy, getLastUpdated, getLastUpdatedBy, toJSON, toString
Collection copy(java.lang.String newName) throws BuildException
newName
- Name of new collectionBuildException
- an exception occurredjava.lang.String getName()
void setName(java.lang.String name) throws BuildException
name
- the name of the collectionBuildException
java.lang.String getGroup() throws BuildException
BuildException
LogicalFile getLogicalFile(java.lang.String file) throws BuildException
file
- optional source fileBuildException
- an exception occurredjava.util.List<LogicalFile> getLogicalFiles(java.lang.String logicalName) throws BuildException
logicalName
- the name of the programBuildException
- an exception occurredjava.util.List<LogicalFile> getLogicalFiles(LogicalDependency logicalDependency) throws BuildException
logicalDependency
- the logical dependency whose criteria is used to find matching
dependencies. Null fields are not used for matching.BuildException
- an exception occurredjava.util.List<LogicalFile> getLogicalFiles() throws BuildException
BuildException
- an exception occurredvoid deleteLogicalFile(java.lang.String file) throws BuildException
file
- the source fileBuildException
- an exception occurredvoid addLogicalFile(LogicalFile lfile) throws BuildException
lfile
- the logical fileBuildException
- an exception occurredvoid addLogicalFiles(java.util.List<LogicalFile> lfiles) throws BuildException
lfiles
- the list of logical filesBuildException
- an exception occurred<IBM Copyright © 2018 IBM Corp. All Rights Reserved.