Package mks.ci.server.engine
Class LocalTriggerManager.ScriptChangePackageEntryBean
- java.lang.Object
-
- mks.frame.triggers.ScriptExposableBaseBean
-
- mks.frame.triggers.beans.ScriptBaseBean
-
- mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean
-
- mks.ci.server.engine.LocalTriggerManager.ScriptCPHasAttributesBean
-
- mks.ci.server.engine.LocalTriggerManager.ScriptGenericChangePackageEntryBean
-
- mks.ci.server.engine.LocalTriggerManager.ScriptChangePackageEntryBean
-
- All Implemented Interfaces:
mks.frame.triggers.ScriptExposableBean
- Enclosing class:
- LocalTriggerManager
public static class LocalTriggerManager.ScriptChangePackageEntryBean extends LocalTriggerManager.ScriptGenericChangePackageEntryBean
A change package entry. Each Change Package has a list of change package entries, corresponding to each modification (update, add, delete, etc.) made in Source Code Management using the associated change package. A list of the entry beans is obtained from the change package bean, via thegetEntryBeans
method.
-
-
Constructor Summary
Constructors Constructor Description ScriptChangePackageEntryBean(int userId, mks.ci.cp.api.CPEntry cpe, java.sql.Connection c)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getArchive()
If the member was not stored in the same archive as its own member name, then the name of the underlying archive.int
getBytesAdded()
Return the number of bytes added by this change package entry.int
getBytesDeleted()
Return the number of bytes deleted by this change package entry.java.lang.String
getConfigPath()
Return the name of the project for this entry.java.lang.String
getExposedName()
Returns the name of this bean that is exposed to the scripting language.int
getLinesAdded()
Return the number of lines added by this change package entry.int
getLinesDeleted()
Return the number of lines deleted by this change package entry.java.lang.String
getLocation()
Either the member archive or the subproject inner project's location.java.lang.String
getMember()
Returns the name of the member of the project.java.lang.String
getProject()
Return the name of the project for this entry.java.lang.String
getRevision()
Returns the revision for the entry.java.lang.String
getServer()
Return the server and port of the Source Code Management server which created this entry.java.util.Date
getTimestamp()
Return the time at which the entry was made.java.lang.String
getVariantProjectName()
If the entry was made in a variant project, return the name of the variant.boolean
isAdd()
Is this an ``add member'' entry?boolean
isAddFromArchive()
Is this an ``add from archive'' entry?boolean
isAddSharedSubproject()
Is this an ``add shared subproject'' entry?boolean
isAddSubproject()
Is this an ``add subproject'' entry?boolean
isCommitted()
Is this a ``committed'' entry?boolean
isConfigureSubprojectFrom()
Is this the from part of a ``configure subproject'' entry?boolean
isConfigureSubprojectTo()
Is this the to part of a ``configure subproject'' entry?boolean
isCreateSubproject()
Is this a ``create subproject'' entry?boolean
isDrop()
Is this a ``drop member'' entry?boolean
isDropSubproject()
Is this a ``drop subproject'' entry?boolean
isExclusiveLock()
Is this an ``exclusive lock member'' entry?boolean
isImport()
Is this an ``import'' entry?boolean
isLock()
Is this a ``lock member'' entry?boolean
isMoveMemberFrom()
Move entries come in two parts, the first is the From entry which contains the old member name / old project name / old variant name with the old revision id.boolean
isMoveMemberTo()
The second part of the move entry, containing the new member name / new project name / new variant name, with the new revision id.boolean
isMoveSubprojectFrom()
Is this the from part of a ``move subproject'' entry?boolean
isMoveSubprojectTo()
Is this the to part of a ``move subproject'' entry?boolean
isNonExclusiveLock()
Is this an ``non exclusive lock member'' entry?boolean
isPending()
Is this a ``pending'' entry?boolean
isRenameFrom()
Rename entries come in two parts, the first is the From entry which contains the old member name with the old revision id.boolean
isRenameTo()
The second part of the rename entry, containing the new member name, with the new revision id.boolean
isText()
Does this change package entry represent a checkin of binary or textual data?boolean
isUpdate()
Is this an ``update'' entry?boolean
isUpdateArchive()
Is this an ``update archive'' entry?boolean
isUpdateRevision()
Is this an ``update member revision'' entry?-
Methods inherited from class mks.ci.server.engine.LocalTriggerManager.ScriptCPHasAttributesBean
getAttributeDisplayValue, getAttributeValue
-
Methods inherited from class mks.ci.server.engine.LocalTriggerManager.ScriptIMBaseBean
getCurrentDatabaseTime, getCurrentDatabaseTime, getCurrentUser, getServerBean, getUserID, isParallelProcessingEnabled
-
Methods inherited from class mks.frame.triggers.beans.ScriptBaseBean
getEnvironmentBean, setEnvironmentBean
-
-
-
-
Method Detail
-
getExposedName
public java.lang.String getExposedName()
Returns the name of this bean that is exposed to the scripting language.- Specified by:
getExposedName
in interfacemks.frame.triggers.ScriptExposableBean
- Overrides:
getExposedName
in classLocalTriggerManager.ScriptGenericChangePackageEntryBean
- Returns:
- the bean name:
imChangePackageEntryBean
.
-
getServer
public java.lang.String getServer() throws mks.frame.triggers.TriggerException
Return the server and port of the Source Code Management server which created this entry.- Throws:
mks.frame.triggers.TriggerException
-
getProject
public java.lang.String getProject() throws mks.frame.triggers.TriggerException
Return the name of the project for this entry.- Throws:
mks.frame.triggers.TriggerException
-
getVariantProjectName
public java.lang.String getVariantProjectName() throws mks.frame.triggers.TriggerException
If the entry was made in a variant project, return the name of the variant. If on the mainline, returns null.- Throws:
mks.frame.triggers.TriggerException
-
getMember
public java.lang.String getMember() throws mks.frame.triggers.TriggerException
Returns the name of the member of the project.- Throws:
mks.frame.triggers.TriggerException
-
getRevision
public java.lang.String getRevision() throws mks.frame.triggers.TriggerException
Returns the revision for the entry. e.g. for an update, this is the new revision number; for a delete this is the revision number at the point where the member was dropped.- Throws:
mks.frame.triggers.TriggerException
-
getLocation
public java.lang.String getLocation() throws mks.frame.triggers.TriggerException
Either the member archive or the subproject inner project's location. Not necessary filled.- Throws:
mks.frame.triggers.TriggerException
-
getArchive
public java.lang.String getArchive() throws mks.frame.triggers.TriggerException
If the member was not stored in the same archive as its own member name, then the name of the underlying archive. Otherwise returns null. Normally only used for lock entries; since a lock is against the underlying archive in case the archive is shared between different projects. deprecate ?- Throws:
mks.frame.triggers.TriggerException
-
getConfigPath
public java.lang.String getConfigPath() throws mks.frame.triggers.TriggerException
Return the name of the project for this entry.- Throws:
mks.frame.triggers.TriggerException
-
isAdd
public boolean isAdd() throws mks.frame.triggers.TriggerException
Is this an ``add member'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isDrop
public boolean isDrop() throws mks.frame.triggers.TriggerException
Is this a ``drop member'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isUpdate
public boolean isUpdate() throws mks.frame.triggers.TriggerException
Is this an ``update'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isRenameFrom
public boolean isRenameFrom() throws mks.frame.triggers.TriggerException
Rename entries come in two parts, the first is the From entry which contains the old member name with the old revision id.- Throws:
mks.frame.triggers.TriggerException
-
isRenameTo
public boolean isRenameTo() throws mks.frame.triggers.TriggerException
The second part of the rename entry, containing the new member name, with the new revision id.- Throws:
mks.frame.triggers.TriggerException
-
isMoveMemberFrom
public boolean isMoveMemberFrom() throws mks.frame.triggers.TriggerException
Move entries come in two parts, the first is the From entry which contains the old member name / old project name / old variant name with the old revision id.- Throws:
mks.frame.triggers.TriggerException
-
isMoveMemberTo
public boolean isMoveMemberTo() throws mks.frame.triggers.TriggerException
The second part of the move entry, containing the new member name / new project name / new variant name, with the new revision id.- Throws:
mks.frame.triggers.TriggerException
-
isExclusiveLock
public boolean isExclusiveLock() throws mks.frame.triggers.TriggerException
Is this an ``exclusive lock member'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isNonExclusiveLock
public boolean isNonExclusiveLock() throws mks.frame.triggers.TriggerException
Is this an ``non exclusive lock member'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isLock
public boolean isLock() throws mks.frame.triggers.TriggerException
Is this a ``lock member'' entry? Returns true if the entry corresponds to either an exclusive or a non exclusive lock.- Throws:
mks.frame.triggers.TriggerException
-
isUpdateRevision
public boolean isUpdateRevision() throws mks.frame.triggers.TriggerException
Is this an ``update member revision'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isImport
public boolean isImport() throws mks.frame.triggers.TriggerException
Is this an ``import'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isAddFromArchive
public boolean isAddFromArchive() throws mks.frame.triggers.TriggerException
Is this an ``add from archive'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isUpdateArchive
public boolean isUpdateArchive() throws mks.frame.triggers.TriggerException
Is this an ``update archive'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isCreateSubproject
public boolean isCreateSubproject() throws mks.frame.triggers.TriggerException
Is this a ``create subproject'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isAddSubproject
public boolean isAddSubproject() throws mks.frame.triggers.TriggerException
Is this an ``add subproject'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isAddSharedSubproject
public boolean isAddSharedSubproject() throws mks.frame.triggers.TriggerException
Is this an ``add shared subproject'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isConfigureSubprojectFrom
public boolean isConfigureSubprojectFrom() throws mks.frame.triggers.TriggerException
Is this the from part of a ``configure subproject'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isConfigureSubprojectTo
public boolean isConfigureSubprojectTo() throws mks.frame.triggers.TriggerException
Is this the to part of a ``configure subproject'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isMoveSubprojectFrom
public boolean isMoveSubprojectFrom() throws mks.frame.triggers.TriggerException
Is this the from part of a ``move subproject'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isMoveSubprojectTo
public boolean isMoveSubprojectTo() throws mks.frame.triggers.TriggerException
Is this the to part of a ``move subproject'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isDropSubproject
public boolean isDropSubproject() throws mks.frame.triggers.TriggerException
Is this a ``drop subproject'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isPending
public boolean isPending() throws mks.frame.triggers.TriggerException
Is this a ``pending'' entry?- Throws:
mks.frame.triggers.TriggerException
-
isCommitted
public boolean isCommitted() throws mks.frame.triggers.TriggerException
Is this a ``committed'' entry?- Throws:
mks.frame.triggers.TriggerException
-
getTimestamp
public java.util.Date getTimestamp() throws mks.frame.triggers.TriggerException
Return the time at which the entry was made.- Throws:
mks.frame.triggers.TriggerException
-
getLinesAdded
public int getLinesAdded() throws mks.frame.triggers.TriggerException
Return the number of lines added by this change package entry.- Returns:
- the number of lines. 0 is returned if isText() is false.
- Throws:
mks.frame.triggers.TriggerException
-
getLinesDeleted
public int getLinesDeleted() throws mks.frame.triggers.TriggerException
Return the number of lines deleted by this change package entry.- Returns:
- the number of lines. 0 is returned if isText() is false.
- Throws:
mks.frame.triggers.TriggerException
-
getBytesAdded
public int getBytesAdded() throws mks.frame.triggers.TriggerException
Return the number of bytes added by this change package entry.- Returns:
- the number of bytes. 0 is returned if isText() is true.
- Throws:
mks.frame.triggers.TriggerException
-
getBytesDeleted
public int getBytesDeleted() throws mks.frame.triggers.TriggerException
Return the number of bytes deleted by this change package entry.- Returns:
- the number of bytes. 0 is returned if isText() is true.
- Throws:
mks.frame.triggers.TriggerException
-
isText
public boolean isText() throws mks.frame.triggers.TriggerException
Does this change package entry represent a checkin of binary or textual data? return true if text, false if binary.- Throws:
mks.frame.triggers.TriggerException
-
-