hudson.model
Interface SCMedItem

All Superinterfaces:
AccessControlled, BuildableItem, Item, ModelObject, PersistenceRoot, Queue.Task, ResourceActivity, Saveable, SearchableModelObject, SearchItem, SubTask
All Known Implementing Classes:
FreeStyleProject, MatrixConfiguration, MatrixProject, MavenModuleSet, Project

public interface SCMedItem
extends BuildableItem

Items that has associated SCM.

Author:
Kohsuke Kawaguchi
See Also:
SCMTrigger

Field Summary
 
Fields inherited from interface hudson.model.Item
BUILD, CANCEL, CONFIGURE, CREATE, DELETE, DISCOVER, EXTENDED_READ, PERMISSIONS, READ, WIPEOUT, WORKSPACE
 
Fields inherited from interface hudson.model.Saveable
NOOP
 
Method Summary
 AbstractProject<?,?> asProject()
          SCMedItem needs to be an instance of AbstractProject.
 SCM getScm()
          Gets the SCM for this item.
 PollingResult poll(TaskListener listener)
          Checks if there's any update in SCM, and returns true if any is found.
 boolean pollSCMChanges(TaskListener listener)
          Deprecated. as of 1.346 Use poll(TaskListener) instead.
 
Methods inherited from interface hudson.model.BuildableItem
scheduleBuild, scheduleBuild, scheduleBuild, scheduleBuild
 
Methods inherited from interface hudson.model.Item
delete, getAbsoluteUrl, getAllJobs, getDisplayName, getFullDisplayName, getFullName, getName, getParent, getRelativeNameFrom, getRelativeNameFrom, getShortUrl, getUrl, onCopiedFrom, onCreatedFromScratch, onLoad, save
 
Methods inherited from interface hudson.model.PersistenceRoot
getRootDir
 
Methods inherited from interface hudson.search.SearchableModelObject
getSearch
 
Methods inherited from interface hudson.search.SearchItem
getSearchIndex, getSearchName, getSearchUrl
 
Methods inherited from interface hudson.security.AccessControlled
checkPermission, getACL, hasPermission
 
Methods inherited from interface hudson.model.Queue.Task
checkAbortPermission, getCauseOfBlockage, getFullDisplayName, getName, getSubTasks, getUrl, getWhyBlocked, hasAbortPermission, isBuildBlocked, isConcurrentBuild
 
Methods inherited from interface hudson.model.queue.SubTask
createExecutable, getAssignedLabel, getEstimatedDuration, getLastBuiltOn, getOwnerTask, getSameNodeConstraint
 
Methods inherited from interface hudson.model.ResourceActivity
getDisplayName, getResourceList
 

Method Detail

getScm

SCM getScm()
Gets the SCM for this item.

Returns:
may return null for indicating "no SCM".

asProject

AbstractProject<?,?> asProject()
SCMedItem needs to be an instance of AbstractProject.

This method must be always implemented as (AbstractProject)this, but defining this method emphasizes the fact that this cast must be doable.


pollSCMChanges

boolean pollSCMChanges(TaskListener listener)
Deprecated. as of 1.346 Use poll(TaskListener) instead.

Checks if there's any update in SCM, and returns true if any is found.


poll

PollingResult poll(TaskListener listener)
Checks if there's any update in SCM, and returns true if any is found.

The implementation is responsible for ensuring mutual exclusion between polling and builds if necessary.

Returns:
never null.
Since:
1.345


Copyright © 2004-2013. All Rights Reserved.