You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by ta...@apache.org on 2004/06/05 07:10:16 UTC
cvs commit: jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common MutableDescriptionSet.java ParameterComposite.java MutableDisplayNameSet.java DublinCore.java MutableDisplayName.java MutableLanguage.java SecurityRoleRefComposite.java MutableDescription.java GenericMetadata.java LocalizedField.java UserAttribute.java
taylor 2004/06/04 22:10:16
Added: jetspeed-api/src/java/org/apache/jetspeed/om/common
MutableDescriptionSet.java ParameterComposite.java
MutableDisplayNameSet.java DublinCore.java
MutableDisplayName.java MutableLanguage.java
SecurityRoleRefComposite.java
MutableDescription.java GenericMetadata.java
LocalizedField.java UserAttribute.java
Log:
move all commons OM interfaces into public API as part of JS2-37
http://nagoya.apache.org/jira/browse/JS2-37
CVS: ----------------------------------------------------------------------
CVS: PR:
CVS: If this change addresses a PR in the problem report tracking
CVS: database, then enter the PR number(s) here.
CVS: Obtained from:
CVS: If this change has been taken from another system, such as NCSA,
CVS: then name the system in this line, otherwise delete it.
CVS: Submitted by:
CVS: If this code has been contributed to Apache by someone else; i.e.,
CVS: they sent us a patch or a new module, then include their name/email
CVS: address here. If this is your work then delete this line.
CVS: Reviewed by:
CVS: If we are doing pre-commit code reviews and someone else has
CVS: reviewed your changes, include their name(s) here.
CVS: If you have not had it reviewed then delete this line.
Revision Changes Path
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/MutableDescriptionSet.java
Index: MutableDescriptionSet.java
===================================================================
/*
* Copyright 2000-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import org.apache.pluto.om.common.Description;
import org.apache.pluto.om.common.DescriptionSet;
/**
* MutableDescriptionSet
*
* @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
* @version $Id: MutableDescriptionSet.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface MutableDescriptionSet extends DescriptionSet
{
void addDescription(Description description);
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/ParameterComposite.java
Index: ParameterComposite.java
===================================================================
/*
* Copyright 2000-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.io.Serializable;
import java.util.Locale;
import org.apache.pluto.om.common.Parameter;
import org.apache.pluto.om.common.ParameterCtrl;
/**
*
* ParameterComposite
*
* @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
* @version $Id: ParameterComposite.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface ParameterComposite extends Parameter, ParameterCtrl, Serializable
{
String TYPE_PORTLET = "org.apache.pluto.om.common.Parameter.portlet";
String TYPE_WEB_APP = "org.apache.pluto.om.common.Parameter.webapp";
void addDescription(Locale locale, String desc);
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/MutableDisplayNameSet.java
Index: MutableDisplayNameSet.java
===================================================================
/*
* Copyright 2000-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import org.apache.pluto.om.common.DisplayName;
import org.apache.pluto.om.common.DisplayNameSet;
/**
* MutableDisplayNameSet
*
* @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
* @version $Id: MutableDisplayNameSet.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface MutableDisplayNameSet extends DisplayNameSet
{
void addDisplayName(DisplayName name);
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/DublinCore.java
Index: DublinCore.java
===================================================================
/* Copyright 2004 Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.util.Collection ;
import java.util.Locale;
/**
* DublinCore
* <br/>
* Interface that allows retrieving information according to the
* Dublin Core specification
* (<a href="http://www.dublincore.org">http://www.dublincore.org</a>)
*
* @author <a href="mailto:jford@apache.org">Jeremy Ford</a>
* @version $Id: DublinCore.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface DublinCore extends java.io.Serializable
{
public Collection getTitles();
public void setTitles(Collection titles);
void addTitle(Locale locale, String title);
public Collection getContributors();
public void setContributors(Collection contributors);
void addContributor(Locale locale, String contributor);
public Collection getCoverages();
public void setCoverages(Collection coverages);
void addCoverage(Locale locale, String coverage);
public Collection getCreators();
public void setCreators(Collection creators);
void addCreator(Locale locale, String creator);
public Collection getDescriptions();
public void setDescriptions(Collection descriptions);
void addDescription(Locale locale, String description);
public Collection getFormats();
public void setFormats(Collection formats);
void addFormat(Locale locale, String format);
public Collection getIdentifiers();
public void setIdentifiers(Collection identifiers);
void addIdentifier(Locale locale, String identifier);
public Collection getLanguages();
public void setLanguages(Collection languages);
void addLanguage(Locale locale, String language);
public Collection getPublishers();
public void setPublishers(Collection publishers);
void addPublisher(Locale locale, String publisher);
public Collection getRelations();
public void setRelations(Collection relations);
void addRelation(Locale locale, String relation);
public Collection getRights();
public void setRights(Collection rights);
void addRight(Locale locale, String right);
public Collection getSources();
public void setSources(Collection sources);
void addSource(Locale locale, String source);
public Collection getSubjects();
public void setSubjects(Collection subjects);
void addSubject(Locale locale, String subject);
public Collection getTypes();
public void setTypes(Collection types);
void addType(Locale locale, String type);
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/MutableDisplayName.java
Index: MutableDisplayName.java
===================================================================
/*
* Copyright 2000-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.util.Locale;
import org.apache.pluto.om.common.DisplayName;
/**
* MutableDisplayName
*
* @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
* @version $Id: MutableDisplayName.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface MutableDisplayName extends DisplayName
{
String TYPE_WEB_APP = "org.apache.pluto.om.common.DisplayName.webapp";
String TYPE_PORTLET = "org.apache.pluto.om.common.DisplayName.portlet";
void setDisplayName(String displayName);
void setLocale(Locale locale);
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/MutableLanguage.java
Index: MutableLanguage.java
===================================================================
/*
* Copyright 2000-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.io.Serializable;
import java.util.Collection;
import java.util.Locale;
import org.apache.pluto.om.common.Language;
/**
*
* MutableLanguage
* <br/>
* Extension of <code>org.apache.pluto.om.common.Language</code>
* with mutator methods for easy maintenance.
*
* @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
* @version $Id: MutableLanguage.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface MutableLanguage extends Language, Serializable
{
void setKeywords(Collection keywords);
/**
*
* @param locale
*/
public void setLocale(Locale locale);
/**
*
* @param title
*/
void setTitle(String title);
/**
*
* @param title
*/
void setShortTitle(String title);
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/SecurityRoleRefComposite.java
Index: SecurityRoleRefComposite.java
===================================================================
/*
* Copyright 2000-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.io.Serializable;
import org.apache.pluto.om.common.Description;
import org.apache.pluto.om.common.DescriptionSet;
import org.apache.pluto.om.common.SecurityRoleRef;
import org.apache.pluto.om.common.SecurityRoleRefCtrl;
/**
*
* SecurityRoleRefComposite
*
* @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
* @version $Id: SecurityRoleRefComposite.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface SecurityRoleRefComposite extends SecurityRoleRef, SecurityRoleRefCtrl, Serializable
{
void addDescription(Description description);
void setDescriptionSet(DescriptionSet descriptions);
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/MutableDescription.java
Index: MutableDescription.java
===================================================================
/*
* Copyright 2000-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.util.Locale;
import org.apache.pluto.om.common.Description;
/**
* MutableDescription
* <br/>
* Extended version of <code>org.apache.pluto.om.common.Description</code>
* that allows for setting the description text and Locale for the description
* object.
*
* @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
* @version $Id: MutableDescription.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface MutableDescription extends Description
{
String TYPE_PORTLET_APP = "org.apache.pluto.om.common.Description.portletApplication";
String TYPE_WEB_APP = "org.apache.pluto.om.common.Description.webApplication";
String TYPE_PORTLET = "org.apache.pluto.om.common.Description.portlet";
String TYPE_PORTLET_ENTITY = "org.apache.pluto.om.common.Description.portletEntity";
String TYPE_PARAMETER = "org.apache.pluto.om.common.Description.parameter";
String TYPE_PREFERENCE = "org.apache.pluto.om.common.Description.preference";
String TYPE_SEC_ROLE_REF = "org.apache.pluto.om.common.Description.securityRoleRef";
void setDescription(String description);
void setLocale(Locale locale);
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/GenericMetadata.java
Index: GenericMetadata.java
===================================================================
/* Copyright 2004 Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.util.Collection;
import java.util.Locale;
/**
* GenericMetadata
* <br/>
* Interface that allows retrieving localized information
*
* @author <a href="mailto:jford@apache.org">Jeremy Ford</a>
* @version $Id: GenericMetadata.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*/
public interface GenericMetadata {
public void addField(Locale locale, String name, String value);
public void addField(LocalizedField field);
public Collection getFields(String name);
public void setFields(String name, Collection values);
public Collection getFields();
public void setFields(Collection fields);
LocalizedField createLocalizedField();
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/LocalizedField.java
Index: LocalizedField.java
===================================================================
/* Copyright 2004 Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.util.Locale;
import org.apache.pluto.om.common.ObjectID;
/**
* LocalizedField
* <br/>
* Interface that represents a string value and the locale of that string
*
* @author <a href="mailto:jford@apache.org">Jeremy Ford</a>
* @version $Id: LocalizedField.java,v 1.1 2004/06/05 05:10:16 taylor Exp $
*
*/
public interface LocalizedField
{
public String getName();
public void setName(String name);
public Locale getLocale();
public void setLocale(Locale locale);
public String getValue();
public void setValue(String value);
/**
* @param objectID
*/
void setId(String objectID);
/**
*
*/
public ObjectID getId();
}
1.1 jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/om/common/UserAttribute.java
Index: UserAttribute.java
===================================================================
/* Copyright 2004 Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jetspeed.om.common;
import java.io.Serializable;
/**
* <p>Interface representing user attribute as defined in Portlet specs:
* PLT.17.2 Accessing User Attributes.</p>
* @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
*
*/
public interface UserAttribute extends Serializable
{
/** Getter for the user-attribute name. */
String getName();
/** Setter for the user-attribute name. */
void setName(String name);
/** Getter for the user-attribute description. */
String getDescription();
/** Setter for the user-attribute description. */
void setDescription(String description);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org