Corrections of the JavaDoc comments of various classes which were causing warnings when creating the JavaDoc.
git-svn-id: https://svn.libreccm.org/ccm/trunk@2507 8810af33-2d31-482b-a856-94f89814c4dfmaster
parent
5659f0bdb4
commit
f23dfe7b10
|
|
@ -38,15 +38,15 @@ public class AtoZConfig extends AbstractConfig {
|
|||
/** A logger instance to assist debugging. */
|
||||
private static final Logger s_log = Logger.getLogger(AtoZConfig.class);
|
||||
|
||||
/** Singelton config object. */
|
||||
/** Singleton config object. */
|
||||
private static AtoZConfig s_conf;
|
||||
|
||||
/**
|
||||
* Gain a AtoZConfig object.
|
||||
*
|
||||
* Singelton pattern, don't instantiate a config object using the
|
||||
* Singleton pattern, don't instantiate a config object using the
|
||||
* constructor directly!
|
||||
* @return
|
||||
* @return The sole and only instance of this class.
|
||||
*/
|
||||
public static synchronized AtoZConfig getConfig() {
|
||||
if (s_conf == null) {
|
||||
|
|
@ -102,7 +102,8 @@ public class AtoZConfig extends AbstractConfig {
|
|||
|
||||
/**
|
||||
* Provides access to the traversal adapter as stream.
|
||||
* @return
|
||||
*
|
||||
* @return InputStream of the traversal adapter.
|
||||
*/
|
||||
InputStream getTraversalAdapters() {
|
||||
return (InputStream)get(m_adapters);
|
||||
|
|
|
|||
|
|
@ -109,7 +109,7 @@ public class CategoryProvider extends AtoZProvider {
|
|||
* @param title
|
||||
* @param description
|
||||
* @param isCompound
|
||||
* @return
|
||||
* @return A new CategoryProvider instance.
|
||||
*/
|
||||
public static CategoryProvider create(String title,
|
||||
String description,
|
||||
|
|
|
|||
|
|
@ -15,7 +15,6 @@
|
|||
* License along with this library; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*/
|
||||
|
||||
package com.arsdigita.atoz;
|
||||
|
||||
import com.arsdigita.domain.DomainCollection;
|
||||
|
|
@ -27,21 +26,18 @@ import com.arsdigita.util.Assert;
|
|||
|
||||
import com.arsdigita.categorization.Category;
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
*/
|
||||
public class ItemProvider extends AtoZProvider {
|
||||
|
||||
public static final String BASE_DATA_OBJECT_TYPE =
|
||||
"com.arsdigita.atoz.ItemProvider";
|
||||
public static final String BASE_DATA_OBJECT_TYPE = "com.arsdigita.atoz.ItemProvider";
|
||||
|
||||
public static final String CATEGORY = "category";
|
||||
public static final String LOAD_PATHS = "loadPaths";
|
||||
|
||||
public static final String ATOMIC_ENTRIES =
|
||||
"com.arsdigita.atoz.getAtomicItemEntries";
|
||||
public static final String ATOMIC_ENTRIES = "com.arsdigita.atoz.getAtomicItemEntries";
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
|
|
@ -52,6 +48,8 @@ public class ItemProvider extends AtoZProvider {
|
|||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param type
|
||||
*/
|
||||
protected ItemProvider(String type) {
|
||||
super(type);
|
||||
|
|
@ -59,6 +57,8 @@ public class ItemProvider extends AtoZProvider {
|
|||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param obj
|
||||
*/
|
||||
public ItemProvider(DataObject obj) {
|
||||
super(obj);
|
||||
|
|
@ -66,6 +66,8 @@ public class ItemProvider extends AtoZProvider {
|
|||
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param oid
|
||||
*/
|
||||
public ItemProvider(OID oid) {
|
||||
super(oid);
|
||||
|
|
@ -103,10 +105,6 @@ public class ItemProvider extends AtoZProvider {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public DomainCollection getAliases() {
|
||||
DomainCollection aliases = new DomainCollection(SessionManager.getSession()
|
||||
.retrieve(ItemAlias.BASE_DATA_OBJECT_TYPE));
|
||||
|
|
@ -123,18 +121,11 @@ public class ItemProvider extends AtoZProvider {
|
|||
set(LOAD_PATHS, loadPaths);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public String getLoadPaths() {
|
||||
return (String) get(LOAD_PATHS);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
@Override
|
||||
public AtoZGenerator getGenerator() {
|
||||
return new ItemGenerator(this);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ import java.util.Iterator;
|
|||
|
||||
/**
|
||||
*
|
||||
* @depcreated UI integrated into Application tab at /ccm/admin. This class is now obsolete
|
||||
* @deprecated UI integrated into Application tab at /ccm/admin. This class is now obsolete
|
||||
* and has been replaced by {@link AtoZAdminPane}. This class is kept here for now, but will be
|
||||
* removed in a further release, together with the Admin UI at /ccm/atoz/admin.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -51,9 +51,7 @@ import org.apache.log4j.Logger;
|
|||
|
||||
/**
|
||||
* Component displays the currently attached images for an content item. It is
|
||||
* part of the entry point image authoring step {
|
||||
*
|
||||
* @see ImageStep}.
|
||||
* part of the entry point image authoring step {@see ImageStep}.
|
||||
*
|
||||
* It creates a list of images including meta information (name, type, width,
|
||||
* etc.), a link to remove from the list for each image and at the bottom a link
|
||||
|
|
|
|||
|
|
@ -42,26 +42,19 @@ import java.util.List;
|
|||
public class MultiPartArticle extends ContentPage {
|
||||
|
||||
private static final Logger s_log = Logger.getLogger(MultiPartArticle.class);
|
||||
|
||||
/** PDL property names */
|
||||
public static final String SUMMARY = "summary";
|
||||
public static final String SECTIONS = "sections";
|
||||
|
||||
|
||||
/** rank direction changes */
|
||||
public static final int UP = 1;
|
||||
public static final int DOWN = 2;
|
||||
|
||||
|
||||
/** data object type for this domain object */
|
||||
public static final String BASE_DATA_OBJECT_TYPE =
|
||||
"com.arsdigita.cms.contenttypes.MultiPartArticle";
|
||||
|
||||
/** named query parameters */
|
||||
public static final String RANK = "rank";
|
||||
public static final String ARTICLE = "article";
|
||||
public static final String SECTION = "section";
|
||||
|
||||
private static MultiPartArticleConfig s_config = new MultiPartArticleConfig();
|
||||
|
||||
static {
|
||||
|
|
@ -85,8 +78,7 @@ public class MultiPartArticle extends ContentPage {
|
|||
* @param id the id of the object to retrieve
|
||||
*/
|
||||
public MultiPartArticle(BigDecimal id)
|
||||
throws DataObjectNotFoundException
|
||||
{
|
||||
throws DataObjectNotFoundException {
|
||||
this(new OID(BASE_DATA_OBJECT_TYPE, id));
|
||||
}
|
||||
|
||||
|
|
@ -96,8 +88,7 @@ public class MultiPartArticle extends ContentPage {
|
|||
* @param id the object id of the object to retrieve
|
||||
*/
|
||||
public MultiPartArticle(OID id)
|
||||
throws DataObjectNotFoundException
|
||||
{
|
||||
throws DataObjectNotFoundException {
|
||||
super(id);
|
||||
}
|
||||
|
||||
|
|
@ -148,8 +139,7 @@ public class MultiPartArticle extends ContentPage {
|
|||
* @param rank the rank of the ArticleSection in the association.
|
||||
*/
|
||||
public void addSection(ArticleSection section, Integer rank) {
|
||||
s_log.info("adding section:" + section.getName() +
|
||||
" with rank " + rank.toString());
|
||||
s_log.info("adding section:" + section.getName() + " with rank " + rank.toString());
|
||||
section.setRank(rank);
|
||||
add(SECTIONS, section);
|
||||
}
|
||||
|
|
@ -167,6 +157,7 @@ public class MultiPartArticle extends ContentPage {
|
|||
|
||||
/**
|
||||
* Get the collection of sections.
|
||||
* @return
|
||||
*/
|
||||
public ArticleSectionCollection getSections() {
|
||||
return getSections(true);
|
||||
|
|
@ -185,11 +176,12 @@ public class MultiPartArticle extends ContentPage {
|
|||
|
||||
/**
|
||||
* Change the rank of a given ArticleSection in this object.
|
||||
* @param sectionID
|
||||
* @param rank
|
||||
*/
|
||||
public void changeSectionRank(BigDecimal sectionID, int rank) {
|
||||
ArticleSection target = (ArticleSection)
|
||||
DomainObjectFactory.newInstance
|
||||
(new OID(ArticleSection.BASE_DATA_OBJECT_TYPE, sectionID));
|
||||
ArticleSection target = (ArticleSection) DomainObjectFactory.newInstance(new OID(
|
||||
ArticleSection.BASE_DATA_OBJECT_TYPE, sectionID));
|
||||
|
||||
changeSectionRank(target, rank);
|
||||
}
|
||||
|
|
@ -204,7 +196,6 @@ public class MultiPartArticle extends ContentPage {
|
|||
changeSectionRank(section, rank);
|
||||
}
|
||||
|
||||
|
||||
protected int getRank(BigDecimal sectionID) {
|
||||
try {
|
||||
ArticleSection section = new ArticleSection(sectionID);
|
||||
|
|
@ -214,7 +205,6 @@ public class MultiPartArticle extends ContentPage {
|
|||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Change the rank of the sections with the given id within this object.
|
||||
* Sets the section rank to that given, and moves all other section ranks
|
||||
|
|
@ -263,7 +253,6 @@ public class MultiPartArticle extends ContentPage {
|
|||
coll.close();
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Returns the highest section rank.
|
||||
*/
|
||||
|
|
@ -282,14 +271,14 @@ public class MultiPartArticle extends ContentPage {
|
|||
}
|
||||
|
||||
public static final int SUMMARY_LENGTH = 200;
|
||||
|
||||
public String getSearchSummary() {
|
||||
final String summary = getSummary();
|
||||
|
||||
if (summary == null) {
|
||||
return "";
|
||||
} else {
|
||||
return com.arsdigita.util.StringUtils.truncateString
|
||||
(summary, SUMMARY_LENGTH, true);
|
||||
return com.arsdigita.util.StringUtils.truncateString(summary, SUMMARY_LENGTH, true);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -298,6 +287,7 @@ public class MultiPartArticle extends ContentPage {
|
|||
final List<ExtraXMLGenerator> generators = super.getExtraXMLGenerators();
|
||||
|
||||
//generators.add(new ArticleSectionPanel());
|
||||
generators.add(new MultiPartArticleDataXMLGenerator());
|
||||
generators.add(new ArticleSectionXMLGenerator());
|
||||
|
||||
return generators;
|
||||
|
|
|
|||
|
|
@ -18,7 +18,6 @@
|
|||
*/
|
||||
package com.arsdigita.cms.contenttypes.ui.mparticle;
|
||||
|
||||
|
||||
import com.arsdigita.bebop.Component;
|
||||
import com.arsdigita.bebop.ControlLink;
|
||||
import com.arsdigita.bebop.Label;
|
||||
|
|
@ -47,7 +46,6 @@ import org.apache.log4j.Logger;
|
|||
|
||||
import java.math.BigDecimal;
|
||||
|
||||
|
||||
/**
|
||||
* A table that displays the sections for the currently
|
||||
* selected MultiPartArticle.
|
||||
|
|
@ -55,16 +53,14 @@ import java.math.BigDecimal;
|
|||
* @author <a href="mailto:dturner@arsdigita.com">Dave Turner</a>
|
||||
* @version $Id: SectionTable.java 2099 2010-04-17 15:35:14Z pboy $
|
||||
*/
|
||||
public class SectionTable extends Table
|
||||
{
|
||||
private static final Logger s_log = Logger.getLogger(SectionTable.class);
|
||||
public class SectionTable extends Table {
|
||||
|
||||
private static final Logger s_log = Logger.getLogger(SectionTable.class);
|
||||
// match columns by (symbolic) index, makes for easier reordering
|
||||
public static final int COL_INDEX_TITLE = 0; // "Section";
|
||||
public static final int COL_INDEX_EDIT = 1; // "Edit";
|
||||
public static final int COL_INDEX_MOVE = 2; // "Move";
|
||||
public static final int COL_INDEX_DELETE = 3; // "Delete";
|
||||
|
||||
private ItemSelectionModel m_selArticle;
|
||||
private ItemSelectionModel m_selSection;
|
||||
private ItemSelectionModel m_moveSection;
|
||||
|
|
@ -87,23 +83,19 @@ public class SectionTable extends Table
|
|||
model.add(new TableColumn(
|
||||
COL_INDEX_TITLE,
|
||||
new Label(MPArticleGlobalizationUtil.globalize(
|
||||
"cms.contenttypes.ui.mparticle.section_table.header_section")
|
||||
) ));
|
||||
"cms.contenttypes.ui.mparticle.section_table.header_section"))));
|
||||
model.add(new TableColumn(
|
||||
COL_INDEX_EDIT,
|
||||
new Label(MPArticleGlobalizationUtil.globalize(
|
||||
"cms.contenttypes.ui.mparticle.section_table.header_edit")
|
||||
) ));
|
||||
"cms.contenttypes.ui.mparticle.section_table.header_edit"))));
|
||||
model.add(new TableColumn(
|
||||
COL_INDEX_MOVE,
|
||||
new Label(MPArticleGlobalizationUtil.globalize(
|
||||
"cms.contenttypes.ui.mparticle.section_table.header_move")
|
||||
) ));
|
||||
"cms.contenttypes.ui.mparticle.section_table.header_move"))));
|
||||
model.add(new TableColumn(
|
||||
COL_INDEX_DELETE,
|
||||
new Label(MPArticleGlobalizationUtil.globalize(
|
||||
"cms.contenttypes.ui.mparticle.section_table.header_delete")
|
||||
) ));
|
||||
"cms.contenttypes.ui.mparticle.section_table.header_delete"))));
|
||||
|
||||
model.get(1).setCellRenderer(new SectionTableCellRenderer(true));
|
||||
model.get(2).setCellRenderer(new SectionTableCellRenderer(true));
|
||||
|
|
@ -125,22 +117,17 @@ public class SectionTable extends Table
|
|||
m_selSection
|
||||
.getSelectedKey(state));
|
||||
} else {
|
||||
MultiPartArticle article = (MultiPartArticle)
|
||||
m_selArticle.getSelectedObject(state);
|
||||
MultiPartArticle article = (MultiPartArticle) m_selArticle.
|
||||
getSelectedObject(state);
|
||||
|
||||
BigDecimal id = (BigDecimal)
|
||||
m_moveSection.getSelectedKey(state);
|
||||
ArticleSection sect = (ArticleSection)
|
||||
DomainObjectFactory.newInstance
|
||||
(new OID
|
||||
(ArticleSection.BASE_DATA_OBJECT_TYPE, id));
|
||||
BigDecimal id = (BigDecimal) m_moveSection.getSelectedKey(state);
|
||||
ArticleSection sect = (ArticleSection) DomainObjectFactory.newInstance(
|
||||
new OID(ArticleSection.BASE_DATA_OBJECT_TYPE, id));
|
||||
|
||||
BigDecimal dest =
|
||||
new BigDecimal((String) event.getRowKey());
|
||||
ArticleSection destSect = (ArticleSection)
|
||||
DomainObjectFactory.newInstance
|
||||
(new OID
|
||||
(ArticleSection.BASE_DATA_OBJECT_TYPE, dest));
|
||||
ArticleSection destSect = (ArticleSection) DomainObjectFactory.newInstance(
|
||||
new OID(ArticleSection.BASE_DATA_OBJECT_TYPE, dest));
|
||||
|
||||
// if sect is lower in rank than the dest
|
||||
// then move below is default behavior
|
||||
|
|
@ -159,10 +146,10 @@ public class SectionTable extends Table
|
|||
public void headSelected(TableActionEvent event) {
|
||||
// do nothing
|
||||
}
|
||||
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
public void setSectionModel(ItemSelectionModel selSection) {
|
||||
if (selSection == null) {
|
||||
s_log.warn("null item model");
|
||||
|
|
@ -170,7 +157,6 @@ public class SectionTable extends Table
|
|||
m_selSection = selSection;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* The model builder to generate a suitable model for the SectionTable
|
||||
*/
|
||||
|
|
@ -180,7 +166,6 @@ public class SectionTable extends Table
|
|||
protected ItemSelectionModel m_selArticle;
|
||||
protected ItemSelectionModel m_moveSection;
|
||||
|
||||
|
||||
/**
|
||||
* Private class constructor.
|
||||
* @param selArticle
|
||||
|
|
@ -192,7 +177,6 @@ public class SectionTable extends Table
|
|||
m_moveSection = moveSection;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
* @param table
|
||||
|
|
@ -210,7 +194,6 @@ public class SectionTable extends Table
|
|||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Internal class
|
||||
*/
|
||||
|
|
@ -223,7 +206,6 @@ public class SectionTable extends Table
|
|||
private ItemSelectionModel m_moveSection;
|
||||
private ArticleSection m_section;
|
||||
|
||||
|
||||
/** Constructor.
|
||||
* @param table
|
||||
* @param state
|
||||
|
|
@ -261,7 +243,9 @@ public class SectionTable extends Table
|
|||
*/
|
||||
public Object getElementAt(int columnIndex) {
|
||||
|
||||
if ( m_colModel == null ) { return null; }
|
||||
if (m_colModel == null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// match columns by (symbolic) index, makes for easier reordering
|
||||
if (columnIndex == COL_INDEX_TITLE) {
|
||||
|
|
@ -270,27 +254,23 @@ public class SectionTable extends Table
|
|||
//return "edit";
|
||||
return new Label(
|
||||
MPArticleGlobalizationUtil.globalize(
|
||||
"cms.contenttypes.ui.mparticle.section_table.link_edit")
|
||||
);
|
||||
"cms.contenttypes.ui.mparticle.section_table.link_edit"));
|
||||
} else if (columnIndex == COL_INDEX_DELETE) {
|
||||
// return "delete";
|
||||
return new Label(
|
||||
MPArticleGlobalizationUtil.globalize(
|
||||
"cms.contenttypes.ui.mparticle.section_table.link_delete")
|
||||
);
|
||||
"cms.contenttypes.ui.mparticle.section_table.link_delete"));
|
||||
} else if (columnIndex == COL_INDEX_MOVE) {
|
||||
if (m_moveSection.getSelectedKey(m_state) == null) {
|
||||
// return "move";
|
||||
return new Label(
|
||||
MPArticleGlobalizationUtil.globalize(
|
||||
"cms.contenttypes.ui.mparticle.section_table.link_move")
|
||||
);
|
||||
"cms.contenttypes.ui.mparticle.section_table.link_move"));
|
||||
} else {
|
||||
// return "move below here";
|
||||
return new Label(
|
||||
MPArticleGlobalizationUtil.globalize(
|
||||
"cms.contenttypes.ui.mparticle.section_table.link_move_below")
|
||||
);
|
||||
"cms.contenttypes.ui.mparticle.section_table.link_move_below"));
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -306,7 +286,6 @@ public class SectionTable extends Table
|
|||
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
|
|
@ -319,8 +298,7 @@ public class SectionTable extends Table
|
|||
this(false);
|
||||
}
|
||||
|
||||
public SectionTableCellRenderer
|
||||
( boolean active ) {
|
||||
public SectionTableCellRenderer(boolean active) {
|
||||
m_active = active;
|
||||
}
|
||||
|
||||
|
|
@ -359,8 +337,5 @@ public class SectionTable extends Table
|
|||
return ret;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -781,7 +781,7 @@ public final class CMSConfig extends AbstractConfig {
|
|||
}
|
||||
|
||||
/**
|
||||
* Retrieve path of the root folter for template folders. Path is
|
||||
* Retrieve path of the root folder for template folders. Path is
|
||||
* relative to webapp root.
|
||||
*/
|
||||
public final String getTemplateRoot() {
|
||||
|
|
|
|||
|
|
@ -27,130 +27,129 @@ import com.arsdigita.persistence.OID;
|
|||
import com.arsdigita.persistence.DataObject;
|
||||
import com.arsdigita.persistence.metadata.ObjectType;
|
||||
|
||||
|
||||
import java.util.Date;
|
||||
|
||||
/**
|
||||
* Base class. Provides default functionality for auditing ACSObjects.
|
||||
*
|
||||
* <p>
|
||||
*
|
||||
* </p>
|
||||
*
|
||||
* @author Joseph Bank
|
||||
* @version 1.0
|
||||
* @version $Id: AuditedACSObject.java 2089 2010-04-17 07:55:43Z pboy $
|
||||
*/
|
||||
|
||||
public abstract class AuditedACSObject extends ACSObject implements Audited {
|
||||
|
||||
/**
|
||||
* Audit trail.
|
||||
*/
|
||||
|
||||
private BasicAuditTrail m_audit_trail;
|
||||
|
||||
/**
|
||||
* Gets the user who created the object. May be null.
|
||||
*
|
||||
* @return the user who created the object.
|
||||
*/
|
||||
|
||||
@Override
|
||||
public User getCreationUser() {
|
||||
return m_audit_trail.getCreationUser();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the creation date of the object.
|
||||
*
|
||||
* @return the creation date.
|
||||
*/
|
||||
|
||||
@Override
|
||||
public Date getCreationDate() {
|
||||
return m_audit_trail.getCreationDate();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the IP address associated with creating an object. May be
|
||||
* null.
|
||||
* Gets the IP address associated with creating an object. May be null.
|
||||
*
|
||||
* @return the creation IP address.
|
||||
*/
|
||||
|
||||
@Override
|
||||
public String getCreationIP() {
|
||||
return m_audit_trail.getCreationIP();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the user who last modified the object. May be null.
|
||||
*
|
||||
* @return the last modifying user.
|
||||
*/
|
||||
|
||||
@Override
|
||||
public User getLastModifiedUser() {
|
||||
return m_audit_trail.getLastModifiedUser();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the last modified date.
|
||||
*
|
||||
* @return the last modified date.
|
||||
*/
|
||||
|
||||
@Override
|
||||
public Date getLastModifiedDate() {
|
||||
return m_audit_trail.getLastModifiedDate();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the last modified IP address. May be null.
|
||||
*
|
||||
* @return the IP address associated with the last modification.
|
||||
*/
|
||||
|
||||
@Override
|
||||
public String getLastModifiedIP() {
|
||||
return m_audit_trail.getLastModifiedIP();
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializes with a basic audit trail and an Auditing Observer.
|
||||
* This method is called from the DomainObject constructor, so it
|
||||
* is invoked whenever a new ACSObject is constructed.
|
||||
*
|
||||
* @post m_audit_trail != null
|
||||
* Initialises with a basic audit trail and an Auditing Observer. This method is called from the
|
||||
* DomainObject constructor, so it is invoked whenever a new ACSObject is constructed.
|
||||
*/
|
||||
|
||||
@Override
|
||||
protected void initialize() {
|
||||
super.initialize();
|
||||
|
||||
//Get the audit trail for this object
|
||||
|
||||
m_audit_trail = BasicAuditTrail.retrieveForACSObject(this);
|
||||
addObserver(new AuditingObserver(m_audit_trail));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Equaivalent to the corresponding ACSObject constructor.
|
||||
* Equivalent to the corresponding ACSObject constructor.
|
||||
*
|
||||
* @param AuditedACSObjectData
|
||||
*/
|
||||
|
||||
protected AuditedACSObject(DataObject AuditedACSObjectData) {
|
||||
super(AuditedACSObjectData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Equaivalent to the corresponding ACSObject constructor.
|
||||
* Equivalent to the corresponding ACSObject constructor.
|
||||
*
|
||||
* @param typeName
|
||||
*/
|
||||
|
||||
public AuditedACSObject(String typeName) {
|
||||
super(typeName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Equaivalent to the corresponding ACSObject constructor.
|
||||
* Equivalent to the corresponding ACSObject constructor.
|
||||
*
|
||||
* @param type
|
||||
*/
|
||||
public AuditedACSObject(ObjectType type) {
|
||||
super(type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Equaivalent to the corresponding ACSObject constructor.
|
||||
* Equivalent to the corresponding ACSObject constructor.
|
||||
*
|
||||
* @param oid
|
||||
*/
|
||||
|
||||
public AuditedACSObject(OID oid) throws DataObjectNotFoundException {
|
||||
super(oid);
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ public class AuditingSaveFactory {
|
|||
/**
|
||||
* Sets the prototype object for the factory.
|
||||
*
|
||||
* @param a prototype AuditingSaveInfo object
|
||||
* @param proto a prototype AuditingSaveInfo object
|
||||
*/
|
||||
public static void setPrototype(AuditingSaveInfo proto) {
|
||||
s_proto.set(proto);
|
||||
|
|
|
|||
|
|
@ -117,12 +117,6 @@ public abstract class PackageLoader extends AbstractScript {
|
|||
s_log.info("Loading: Done");
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*
|
||||
* @param args
|
||||
* @return
|
||||
*/
|
||||
public static ParameterReader reader(String[] args) {
|
||||
CompoundParameterReader result = new CompoundParameterReader();
|
||||
result.add(new JavaPropertyReader(props(args)));
|
||||
|
|
|
|||
|
|
@ -45,9 +45,9 @@ import javax.servlet.http.HttpServletResponse;
|
|||
* Web Developer Support Application Servlet class, central entry point to create and process the applications UI.
|
||||
*
|
||||
* We should have subclassed BebopApplicationServlet but couldn't overwrite doService() method to add permission
|
||||
* checking. So we use our own page mapping. The general logic is the same as for BebopApplicationServlet. {
|
||||
* checking. So we use our own page mapping. The general logic is the same as for BebopApplicationServlet.
|
||||
*
|
||||
* @see com.arsdigita.bebop.page.BebopApplicationServlet}
|
||||
* {@see com.arsdigita.bebop.page.BebopApplicationServlet}
|
||||
*
|
||||
* @author Jens Pelzetter
|
||||
* @author pb
|
||||
|
|
|
|||
|
|
@ -141,7 +141,7 @@ public class Application extends Resource {
|
|||
* @param fragment URL fragment of the application
|
||||
* @param title
|
||||
* @param parent parent Application
|
||||
* @return
|
||||
* @return The new Application
|
||||
*/
|
||||
public static Application createApplication(final ApplicationType type,
|
||||
final String fragment,
|
||||
|
|
@ -158,7 +158,7 @@ public class Application extends Resource {
|
|||
* @param fragment URL fragment of the application
|
||||
* @param title
|
||||
* @param parent
|
||||
* @return
|
||||
* @return The new application
|
||||
*/
|
||||
public static Application createApplication(final String typeName,
|
||||
final String fragment,
|
||||
|
|
@ -175,7 +175,7 @@ public class Application extends Resource {
|
|||
* @param title
|
||||
* @param parent
|
||||
* @param createContainerGroup
|
||||
* @return
|
||||
* @return The new application
|
||||
*/
|
||||
public static Application createApplication(
|
||||
final String typeName,
|
||||
|
|
@ -205,7 +205,7 @@ public class Application extends Resource {
|
|||
* @param title
|
||||
* @param parent parent application
|
||||
* @param createContainerGroup
|
||||
* @return
|
||||
* @return The new application
|
||||
*/
|
||||
public static Application createApplication(
|
||||
final ApplicationType type,
|
||||
|
|
@ -233,7 +233,7 @@ public class Application extends Resource {
|
|||
* @param title descriptive name
|
||||
* @param parent
|
||||
* @param createContainerGroup
|
||||
* @return
|
||||
* @return The new application
|
||||
*/
|
||||
private static Application make(final ApplicationType type,
|
||||
final String fragment,
|
||||
|
|
@ -283,8 +283,8 @@ public class Application extends Resource {
|
|||
|
||||
/**
|
||||
*
|
||||
* @param id
|
||||
* @return
|
||||
* @param id The id of the application instance.
|
||||
* @return The application instance identified by {@code id}.
|
||||
*/
|
||||
public static Application retrieveApplication(BigDecimal id) {
|
||||
OID oid = new OID(BASE_DATA_OBJECT_TYPE, id);
|
||||
|
|
@ -294,8 +294,8 @@ public class Application extends Resource {
|
|||
|
||||
/**
|
||||
*
|
||||
* @param oid
|
||||
* @return
|
||||
* @param oid The {@link OID} of the application to retrieve.
|
||||
* @return The application instance identified by {@code oid}
|
||||
*/
|
||||
public static Application retrieveApplication(OID oid) {
|
||||
DataObject dataObject = SessionManager.getSession().retrieve(oid);
|
||||
|
|
@ -309,8 +309,8 @@ public class Application extends Resource {
|
|||
|
||||
/**
|
||||
*
|
||||
* @param dobj
|
||||
* @return
|
||||
* @param dobj A {@link DataObject} representing a application instance.
|
||||
* @return A DomainObject representing the application instance.
|
||||
*/
|
||||
public static Application retrieveApplication(DataObject dobj) {
|
||||
Assert.exists(dobj, DataObject.class);
|
||||
|
|
@ -324,11 +324,6 @@ public class Application extends Resource {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @param obj
|
||||
* @return
|
||||
*/
|
||||
public static Application getContainingApplication(ACSObject obj) {
|
||||
Assert.exists(obj, ACSObject.class);
|
||||
ACSObject result = obj.gimmeContainer();
|
||||
|
|
@ -342,8 +337,9 @@ public class Application extends Resource {
|
|||
|
||||
/**
|
||||
*
|
||||
* @param path
|
||||
* @return (Can return null.)
|
||||
* @param path Path of the application to retrieve
|
||||
* @return The application mounted at {@code path} or {@code null} if there is not such
|
||||
* application.
|
||||
*/
|
||||
public static Application retrieveApplicationForPath(String path) {
|
||||
|
||||
|
|
@ -397,7 +393,7 @@ public class Application extends Resource {
|
|||
/**
|
||||
* .
|
||||
* Ordered from most distant to closest ancestor.
|
||||
* @return
|
||||
* @return List of the ancestor applications.
|
||||
*/
|
||||
public List getAncestorApplications() {
|
||||
// This is the stupid implementation.
|
||||
|
|
@ -436,7 +432,7 @@ public class Application extends Resource {
|
|||
/**
|
||||
*
|
||||
* @param applicationType
|
||||
* @return
|
||||
* @return Collection of the child applications
|
||||
*/
|
||||
public ApplicationCollection getChildApplicationsForType(String applicationType) {
|
||||
ApplicationCollection children = getChildApplications();
|
||||
|
|
@ -583,7 +579,7 @@ public class Application extends Resource {
|
|||
*
|
||||
* @param applicationObjectType
|
||||
* @param path
|
||||
* @return
|
||||
* @return {@code true} if the application type is installed, {@code false} otherwise.
|
||||
*/
|
||||
public static boolean isInstalled(String applicationObjectType,
|
||||
String path) {
|
||||
|
|
@ -619,10 +615,6 @@ public class Application extends Resource {
|
|||
return canonicalURL;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @return
|
||||
*/
|
||||
public String getContextPath() {
|
||||
return "";
|
||||
}
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ import org.apache.log4j.Logger;
|
|||
|
||||
/**
|
||||
*
|
||||
* @author
|
||||
* @author unknown
|
||||
*/
|
||||
public class PersonalPortalPage extends Page {
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ import com.arsdigita.portal.Portlet;
|
|||
|
||||
/**
|
||||
*
|
||||
* @author
|
||||
* @author unknown
|
||||
*/
|
||||
public class RSSFeedPortletEditorForm extends PortletConfigFormSection {
|
||||
|
||||
|
|
|
|||
|
|
@ -211,8 +211,6 @@ public class SeriesExtraXmlGenerator implements ExtraXMLGenerator {
|
|||
});
|
||||
}
|
||||
|
||||
|
||||
|
||||
final Element volumesElem = parent.newChildElement("volumes");
|
||||
for (VolumeEntry entry : volumeList) {
|
||||
createVolumeXml(entry.getPublication(), entry.getVolumeOfSeries(), volumesElem, state);
|
||||
|
|
|
|||
Loading…
Reference in New Issue