AttributesPropertyClass


1   package com.sslexplorer.properties.attributes;
2   
3   import com.sslexplorer.boot.PropertyClass;
4   import com.sslexplorer.properties.impl.userattributes.UserAttributes;
5   
6   /**
7    * Specialisation of a <i>Property Class</i> for <i>Attributes</i>.
8    * <p>
9    * Attributes differ from properties in that an administrator may actually
10   * create new <i>Attribute Definitions</i> and the define and use them in
11   * various SSL-Explorer features.
12   * <p>
13   * For example, {@link UserAttributes} may be defined by administrator. An
14   * individual users and or administrator may then set the values for the each of
15   * these attributes. The attribute name may then be used as a <i>Replacement
16   * Variable</i> in various places, such as in the URI of a <i>Network Place</i>
17   * or the value of an <i>Application Shortcut</i> parameter.
18   * <p>
19   * See {@link AttributeDefinition} for more details.
20   * 
21   * @author brett
22   * @see AttributeDefinition
23   * 
24   */
25  public interface AttributesPropertyClass extends PropertyClass {
26      /**
27       * Get the default bundle name for the property class. This bundle is used
28       * to get the localised name of the attributes class.
29       * 
30       * @return message resources key
31       */
32      public String   getMessageResourcesKey();
33  
34      /**
35       * Get whether the class of attribute supports the user visiblity flag.
36       * 
37       * @return supports user visibility
38       */
39      public boolean isSupportsVisibility();
40  
41      /**
42       * Create a new instance of an attribute definition appropriate for this
43       * attribute class. This is used by the wizard.
44       * 
45       * @param type
46       *            type
47       * @param name
48       *            name
49       * @param typeMeta
50       *            type meta
51       * @param category
52       *            category ID or <code>-1</code> to use the categoryLabel
53       * @param categoryLabel
54       *            category label or <code>null</code>
55       * @param defaultValue
56       *            default value
57       * @param visibility
58       *            visibility. See class description
59       * @param sortOrder
60       *            sort order
61       * @param messageResourcesKey
62       * @param hidden
63       *            hidden
64       * @param label
65       *            label
66       * @param description
67       *            description
68       * @param system
69       *            system
70       * @param replaceable
71       * @param validationString
72       *            validation string
73       * @return attribute definition
74       */
75      public AttributeDefinition createAttributeDefinition(int type, String   name, String   typeMeta, int category, String   categoryLabel, String   defaultValue,
76              int visibility, int sortOrder, String   messageResourcesKey, boolean hidden, String   label, String   description, boolean system, boolean replaceable, String   validationString);
77  }
78
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags