com.atlassian.jira.appconsistency.integrity.check
Class PortletCheck

java.lang.Object
  com.atlassian.jira.appconsistency.integrity.check.CheckImpl
      com.atlassian.jira.appconsistency.integrity.check.PortletCheck

All Implemented Interfaces:

Check

Direct Known Subclasses:

ProjectPortletCheck, SearchRequestPortletCheck

public abstract class PortletCheck
extends CheckImpl

Field Summary

protected static org.apache.log4j.Logger

log

Fields inherited from class com.atlassian.jira.appconsistency.integrity.check.CheckImpl

id, ofBizDelegator

Constructor Summary

PortletCheck(OfBizDelegator ofBizDelegator, Long id, PortalPageManager portalPageManager, UserManager userManager)

Method Summary

List	correct()
protected List	getAmendments(String portletConfEntityName, String propertyKey, boolean includeMessageSuffix)
String	getDescription()
IntegrityCheck	getIntegrityCheck()
protected abstract String	getPropertyEntity()
protected abstract String	getPropertyKey()
String	getUnavailableMessage()
protected UserManager	getUserManager()
boolean	isAvailable()
List	preview()
void	setIntegrityCheck(IntegrityCheck integrityCheck)
protected boolean	shouldPortletBeDeleted(String entityName, String entityIdStr) Returns true if a Entity CANNOT be found with the specified id.

Methods inherited from class com.atlassian.jira.appconsistency.integrity.check.CheckImpl

getI18NBean, getId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static final org.apache.log4j.Logger log

Constructor Detail

PortletCheck

public PortletCheck(OfBizDelegator ofBizDelegator,
                    Long id,
                    PortalPageManager portalPageManager,
                    UserManager userManager)

Method Detail

getDescription

public String getDescription()

preview

public List preview()
             throws IntegrityException

Throws:

IntegrityException

correct

public List correct()
             throws IntegrityException

Throws:

IntegrityException

getIntegrityCheck

public IntegrityCheck getIntegrityCheck()

Specified by:

getIntegrityCheck in interface Check

Overrides:

getIntegrityCheck in class CheckImpl

setIntegrityCheck

public void setIntegrityCheck(IntegrityCheck integrityCheck)

Specified by:

setIntegrityCheck in interface Check

Overrides:

setIntegrityCheck in class CheckImpl

isAvailable

public boolean isAvailable()

getUnavailableMessage

public String getUnavailableMessage()

getPropertyKey

protected abstract String getPropertyKey()

getPropertyEntity

protected abstract String getPropertyEntity()

getUserManager

protected UserManager getUserManager()

getAmendments

protected List getAmendments(String portletConfEntityName,
                             String propertyKey,
                             boolean includeMessageSuffix)
                      throws IntegrityException

Throws:

IntegrityException

shouldPortletBeDeleted

protected boolean shouldPortletBeDeleted(String entityName,
                                         String entityIdStr)
                                  throws org.ofbiz.core.entity.GenericEntityException

Returns true if a Entity CANNOT be found with the specified id.

Parameters:

entityIdStr - the id string of the entity to look for

entityName - the name of the entity to look for

Returns:

Returns true if a Entity CANNOT be found with the specified id.

Throws:

org.ofbiz.core.entity.GenericEntityException - if stuff goes wrong