Interface ILibrary
-
- All Superinterfaces:
com4j.Com4jObject
,IBaseField
,IBaseFieldEx
,IBaseFieldExMail
,IObjectLockingSupport
public interface ILibrary extends IBaseFieldExMail
For HP use. Represents a Library.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com4j.Com4jObject
baselineFactory()
For HP use.int
beginSync(ILibraryInfo srcLibrary, int srcBaselineId, int comparisonId, IList fieldsToSync)
For HP use.ILibraryOperationResult
createBaselineVerification()
For HP use.Date
creationDate()
The Date at which the library was createdString
creatorUser()
The user name of the library creator or importer.void
creatorUser(String pVal)
The user name of the library creator or importer.int
getLibraryTaskId()
The asynchronous task ID of this library.com4j.Com4jObject
libraryInfo()
For HP use.com4j.Com4jObject
libraryPartFactory()
The library parts factory of this library.int
libType()
The Library Type (Created, Imported, TBD)String
name()
The library's namevoid
name(String pVal)
The library's namecom4j.Com4jObject
parent()
The library's parent library folderILibraryOperationResult
syncLibrariesVerification(ILibraryInfo srcLibrary, int srcBaselineId, int comparisonId)
For HP use.-
Methods inherited from interface com4j.Com4jObject
advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString
-
Methods inherited from interface step.repository.alm.otaclient.IBaseField
autoPost, autoPost, field, field, id, modified, post, refresh, undo, virtual
-
Methods inherited from interface step.repository.alm.otaclient.IBaseFieldEx
attachments, hasAttachment, history
-
Methods inherited from interface step.repository.alm.otaclient.IBaseFieldExMail
mail
-
Methods inherited from interface step.repository.alm.otaclient.IObjectLockingSupport
isLocked, lockObject, unLockObject
-
-
-
-
Method Detail
-
libType
int libType()
The Library Type (Created, Imported, TBD)
Getter method for the COM property "LibType"
- Returns:
- Returns a value of type int
-
name
String name()
The library's name
Getter method for the COM property "Name"
- Returns:
- Returns a value of type java.lang.String
-
name
void name(String pVal)
The library's name
Setter method for the COM property "Name"
- Parameters:
pVal
- Mandatory java.lang.String parameter.
-
parent
com4j.Com4jObject parent()
The library's parent library folder
Getter method for the COM property "Parent"
- Returns:
- Returns a value of type com4j.Com4jObject
-
creatorUser
String creatorUser()
The user name of the library creator or importer.
Getter method for the COM property "CreatorUser"
- Returns:
- Returns a value of type java.lang.String
-
creatorUser
void creatorUser(String pVal)
The user name of the library creator or importer.
Setter method for the COM property "CreatorUser"
- Parameters:
pVal
- Mandatory java.lang.String parameter.
-
creationDate
Date creationDate()
The Date at which the library was created
Getter method for the COM property "CreationDate"
- Returns:
- Returns a value of type java.util.Date
-
libraryPartFactory
com4j.Com4jObject libraryPartFactory()
The library parts factory of this library.
Getter method for the COM property "LibraryPartFactory"
- Returns:
- Returns a value of type com4j.Com4jObject
-
baselineFactory
com4j.Com4jObject baselineFactory()
For HP use. The factory that manages baselines of this Library.
Getter method for the COM property "BaselineFactory"
- Returns:
- Returns a value of type com4j.Com4jObject
-
beginSync
int beginSync(ILibraryInfo srcLibrary, int srcBaselineId, int comparisonId, IList fieldsToSync)
For HP use. Synchronizes another library baseline into the current library. Both libraries type may be either exportable or imported.
- Parameters:
srcLibrary
- Mandatory otaclient.ILibraryInfo parameter.srcBaselineId
- Mandatory int parameter.comparisonId
- Mandatory int parameter.fieldsToSync
- Mandatory otaclient.IList parameter.- Returns:
- Returns a value of type int
-
libraryInfo
com4j.Com4jObject libraryInfo()
For HP use. Returns the LibraryInfo of this library. The returned baseline data is meaningless (it is here only because it is a part of the LibraryInfo data)~~~
Getter method for the COM property "LibraryInfo"
- Returns:
- Returns a value of type com4j.Com4jObject
-
createBaselineVerification
ILibraryOperationResult createBaselineVerification()
For HP use. Performs verification before baseline creation
- Returns:
- Returns a value of type otaclient.ILibraryOperationResult
-
syncLibrariesVerification
ILibraryOperationResult syncLibrariesVerification(ILibraryInfo srcLibrary, int srcBaselineId, int comparisonId)
For HP use. Performs verification before libraries synchronization
- Parameters:
srcLibrary
- Mandatory otaclient.ILibraryInfo parameter.srcBaselineId
- Mandatory int parameter.comparisonId
- Mandatory int parameter.- Returns:
- Returns a value of type otaclient.ILibraryOperationResult
-
getLibraryTaskId
int getLibraryTaskId()
The asynchronous task ID of this library.
- Returns:
- Returns a value of type int
-
-