This project has retired. For details please refer to its Attic page.

org.apache.lenya.cms.ant
Class DeactivateResourcesTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.apache.lenya.cms.ant.PublicationTask
              org.apache.lenya.cms.ant.DeactivateResourcesTask

public class DeactivateResourcesTask
extends PublicationTask

Ant task to remove the resources belonging to a document with document id , area and language . The resources are removed when no more version of this document is available.

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

project

Constructor Summary

DeactivateResourcesTask()
Creates a new instance of DeactivateResourcesTask

Method Summary

void	deactivateResources(java.lang.String language, java.lang.String documentid, java.lang.String area) Remove the resources belonging to the document with document id , area and language , when no more version of this document is available.
void	execute() (non-Javadoc)
java.lang.String	getArea() Get the value of the area.
java.lang.String	getDocumentid() Get the value of the document id.
java.lang.String	getLanguage() Get the value of the language.
void	setArea(java.lang.String string) Set the value of the area.
void	setDocumentid(java.lang.String string) Set the value of the document id.
void	setLanguage(java.lang.String string) Set the value of the language.

Methods inherited from class org.apache.lenya.cms.ant.PublicationTask

assertString, getContextPrefix, getPublication, getPublicationDirectory, getPublicationId, getServletContext

Methods inherited from class org.apache.tools.ant.Task

getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

DeactivateResourcesTask

public DeactivateResourcesTask()

Creates a new instance of DeactivateResourcesTask

Method Detail

deactivateResources

public void deactivateResources(java.lang.String language,
                                java.lang.String documentid,
                                java.lang.String area)
                         throws SiteTreeException

Remove the resources belonging to the document with document id , area and language , when no more version of this document is available.

Parameters:

language - The language

documentid - The document id

area - The area

Throws:

SiteTreeException - if an error occurs

execute

public void execute()
             throws org.apache.tools.ant.BuildException

(non-Javadoc)

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

See Also:

Task.execute()

getArea

public java.lang.String getArea()

Get the value of the area.

Returns:

The area.

getDocumentid

public java.lang.String getDocumentid()

Get the value of the document id.

Returns:

The document id.

getLanguage

public java.lang.String getLanguage()

Get the value of the language.

Returns:

The language.

setArea

public void setArea(java.lang.String string)

Set the value of the area.

Parameters:

string - The area.

setDocumentid

public void setDocumentid(java.lang.String string)

Set the value of the document id.

Parameters:

string - The document id.

setLanguage

public void setLanguage(java.lang.String string)

Set the value of the language.

Parameters:

string - The language.