portals-jetspeed-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wea...@apache.org
Subject cvs commit: jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/prefs/om package.html PropertyKey.java Node.java Property.java
Date Fri, 16 Jul 2004 19:30:39 GMT
weaver      2004/07/16 12:30:39

  Added:       jetspeed-api/src/java/org/apache/jetspeed/prefs/om
                        package.html PropertyKey.java Node.java
                        Property.java
  Removed:     components/prefs/src/java/org/apache/jetspeed/prefs/om
                        PropertyKey.java package.html Node.java
                        Property.java
  Log:
  property and prefs interfaces moved to jetspeed-api
  
  Revision  Changes    Path
  1.1                  jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/prefs/om/package.html
  
  Index: package.html
  ===================================================================
  <html>
  <head>
    <title>org.apache.jetspeed.om.usermgt</title>
  </head>
  <body>
  
    <p>Interface used for the object model backing Jetspeed
    java.util.prefs.Preferences. These objects
    are used through OJB for persisting data.</p>
    
  </body>
  </html>
  
  
  
  1.1                  jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/prefs/om/PropertyKey.java
  
  Index: PropertyKey.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.prefs.om;
  
  import java.io.Serializable;
  import java.sql.Timestamp;
  
  /**
   * <p>Interface representing a property key.</p>
   *
   * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
   */
  public interface PropertyKey extends Serializable, Cloneable
  {
  
      /**
       * <p>Getter for the property key id.</p>
       * @return The property key id.
       */
      long getPropertyKeyId();
  
      /**
       * <p>Setter for the property key id.</p>
       * @param propertyKeyId The property key id.
       */
      void setPropertyKeyId(long propertyKeyId);
  
      /**
       * <p>Getter for the property key name.</p>
       * @return The property key name.
       */
      String getPropertyKeyName();
  
      /**
       * <p>Setter for the property key name.</p>
       * @param propertyKeyName The property key name.
       */
      void setPropertyKeyName(String propertyKeyName);
  
      /**
       * <p>Getter for the property key type.</p>
       * <ul>
       *     <li>0=Boolean,</li>
       *     <li>1=Long,</li>
       *     <li>2=Double,</li>
       *     <li>3=String,</li>
       *     <li>4=Timestamp</li>
       * </ul>
       * @return The property key type.
       */
      int getPropertyKeyType();
  
      /**
       * <p>Setter for the property key type.</p>
       * <ul>
       *     <li>0=Boolean,</li>
       *     <li>1=Long,</li>
       *     <li>2=Double,</li>
       *     <li>3=String,</li>
       *     <li>4=Timestamp</li>
       * </ul>
       * @param propertyKeyType The property key type.
       */
      void setPropertyKeyType(int propertyKeyType);
  
      /**
       * <p>Getter for creation date.</p>
       * @return The creation date.
       */
      Timestamp getCreationDate();
  
      /**
       * <p>Setter for the creation date.</p>
       * @param creationDate The creation date.
       */
      void setCreationDate(Timestamp creationDate);
  
      /**
       * <p>Getter for the modified date.</p>
       * @return The modified date.
       */
      Timestamp getModifiedDate();
  
      /**
       * <p>Setter for the modified date.</p>
       * @param modifiedDate The modified date.
       */
      void setModifiedDate(Timestamp modifiedDate);
  
  }
  
  
  
  1.1                  jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/prefs/om/Node.java
  
  Index: Node.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.prefs.om;
  
  import java.io.Serializable;
  import java.util.Collection;
  import java.sql.Timestamp;
  
  /**
   * <p>Interface representing a {@link java.util.prefs.Preferences}
   * node.</p>
   *
   * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
   */
  public interface Node extends Serializable, Cloneable
  {
  
      /**
       * <p>Getter for the node id.</p>
       * @return The node id.
       */
      long getNodeId();
  
      /**
       * <p>Setter for the node id.</p>
       * @param nodeId The node id.
       */
      void setNodeId(long nodeId);
  
      /**
       * <p>Getter for the parent node id.</p>
       * <p>Passed as an Integer to be able to pass null if no parent
       * is associated to a node.</p>
       * @return The parent node id.
       */
      Long getParentNodeId();
  
      /**
       * <p>Setter for the parent node id.</p>
       * @param parentNodeId The parent node id.
       */
      void setParentNodeId(Long parentNodeId);
  
      /**
       * <p>Getter for the node properties.</p>
       * @return The node properties.
       */
      Collection getNodeProperties();
  
      /**
       * <p>Setter for the node properties.</p>
       * @param properties The node properties.
       */
      void setNodeProperties(Collection nodeProperties);
  
      /**
       * <p>Getter for the keys associated to a specific nodes.</p>
       * @return The node keys.
       */
      Collection getNodeKeys();
  
      /**
       * <p>Setter for the keys associated to a specific nodes.</p>
       * @param nodeKeys The node keys.
       */
      void setNodeKeys(Collection nodeKeys);
  
      /**
       * <p>Getter for the node name.</p>
       * @return The node name.
       */
       String getNodeName();
  
      /**
       * <p>Setter for the node name.</p>
       * @param nodeName The node name.
       */
       void setNodeName(String nodeName);
  
      /**
       * <p>Getter for the node type.</p>
       * <ul>
       *     <li>0=user,</li>
       *     <li>1=system,</li>
       * </ul>
       * @return The node type.
       */
      int getNodeType();
  
      /**
       * <p>Setter for the node type.</p>
       * <ul>
       *     <li>0=user,</li>
       *     <li>1=system,</li>
       * </ul>
       * @param nodeType The node type.
       */
      void setNodeType(int nodeType);
  
      /**
       * <p>Getter for the full path.</p>
       * @return The full path.
       */
      String getFullPath();
  
      /**
       * <p>Setter for the full path.</p>
       * @param fullPath The full path.
       */
      void setFullPath(String fullPath);
  
      /**
       * <p>Getter for creation date.</p>
       * @return The creation date.
       */
      Timestamp getCreationDate();
  
      /**
       * <p>Setter for the creation date.</p>
       * @param creationDate The creation date.
       */
      void setCreationDate(Timestamp creationDate);
  
      /**
       * <p>Getter for the modified date.</p>
       * @return The modified date.
       */
      Timestamp getModifiedDate();
  
      /**
       * <p>Setter for the modified date.</p>
       * @param modifiedDate The modified date.
       */
      void setModifiedDate(Timestamp modifiedDate);
  
  }
  
  
  
  1.1                  jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/prefs/om/Property.java
  
  Index: Property.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.prefs.om;
  
  import java.io.Serializable;
  import java.sql.Timestamp;
  
  /**
   * <p>Interface representing a property key/value pair.</p>
   *
   * @author <a href="mailto:dlestrat@apache.org">David Le Strat</a>
   */
  public interface Property extends Serializable, Cloneable
  {
  
      /** <p>Constant for <code>boolean</code> property value object type.</p>
*/
      int BOOLEAN_TYPE = 0;
  
      /** <p>Constant for <code>long</code> property value object type.</p>
*/
      int LONG_TYPE = 1;
  
      /** <p>Constant for <code>double</code> property value object type.</p>
*/
      int DOUBLE_TYPE = 2;
  
      /** <p>Constant for <code>String</code> property value object type.</p>
*/
      int STRING_TYPE = 3;
  
      /** <p>Constant for <code>Timestamp</code> property value object type.</p>
*/
      int TIMESTAMP_TYPE = 3;
  
      /**
       * <p>Getter for the property value id.</p>
       * @return The property value id.
       */
      long getPropertyValueId();
  
      /**
       * <p>Setter for the property value id.</p>
       * @param propertyValueId The property value id.
       */
      void setPropertyValueId(long propertyValueId);
  
      /**
       * <p>Getter for the node id.</p>
       * @return The node id.
       */
      long getNodeId();
  
      /**
       * <p>Setter for the node id.</p>
       * @param nodeId The node id.
       */
      void setNodeId(long nodeId);
  
      /**
       * <p>Getter for the node id.</p>
       * @return The property key id.
       */
      long getPropertyKeyId();
  
      /**
       * <p>Setter for the property key id.</p>
       * @param propertyKeyId The property key id.
       */
      void setPropertyKeyId(long propertyKeyId);
  
      /**
       * <p>Getter for the property key object.</p>
       * @return The property key object.
       */
      PropertyKey getPropertyKey();
  
      /**
       * <p>Setter for the property key object.</p>
       * @param propertyKey The property key object.
       */
      void setPropertyKey(PropertyKey propertyKey);
  
      /**
       * <p>Utility method used to return the property value 
       * as a String.</p>
       * @param valueObjectType The value object type.
       * @return The property value as a String.
       */
      String getPropertyValue(int valueObjectType);
  
      /**
       * <p>Utility method used to identify with property value to set
       * based on the value object type.</p>
       * @param valueObjectType The value object type.
       * @param valueObject The value object.
       */
      void setPropertyValue(int valueObjectType, String valueObject);
  
      /**
       * <p>Getter for the boolean property value.</p>
       * @return The boolean property value.
       */
      boolean getBooleanPropertyValue();
  
      /**
       * <p>Setter for the boolean property value.</p>
       * @param booleanPropertyValue The boolean property value.
       */
      void setBooleanPropertyValue(boolean booleanPropertyValue);
  
      /**
       * <p>Getter for the date property value.</p>
       * @return The date property value.
       */
      Timestamp getDatePropertyValue();
  
      /**
       * <p>Setter for the date property value.</p>
       * @param datePropertyValue The date property value.
       */
      void setDatePropertyValue(Timestamp datePropertyValue);
  
      /**
       * <p>Getter for the long property value.</p>
       * @return The long property value.
       */
      long getLongPropertyValue();
  
      /**
       * <p>Setter for the long property value.</p>
       * @param longPropertyValue The long property value.
       */
      void setLongPropertyValue(long longPropertyValue);
  
      /**
       * <p>Getter for the double property value.</p>
       * @return The double property value.
       */
      double getDoublePropertyValue();
  
      /**
       * <p>Setter for the double property value.</p>
       * @param doublePropertyValue The double property value.
       */
      void setDoublePropertyValue(double doublePropertyValue);
  
      /**
       * <p>Getter for the text property value.</p>
       * @return The text property value.
       */
      String getTextPropertyValue();
  
      /**
       * <p>Setter for the text property value.</p>
       * @param textPropertyValue The text property value.
       */
      void setTextPropertyValue(String textPropertyValue);
  
      /**
       * <p>Getter for creation date.</p>
       * @return The creation date.
       */
      Timestamp getCreationDate();
  
      /**
       * <p>Setter for the creation date.</p>
       * @param creationDate The creation date.
       */
      void setCreationDate(Timestamp creationDate);
  
      /**
       * <p>Getter for the modified date.</p>
       * @return The modified date.
       */
      Timestamp getModifiedDate();
  
      /**
       * <p>Setter for the modified date.</p>
       * @param modifiedDate The modified date.
       */
      void setModifiedDate(Timestamp modifiedDate);
  
  }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org


Mime
View raw message