Java Doc for PropertyResponse.java in  » Content-Management-System » harmonise » com » ibm » webdav » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Content Management System » harmonise » com.ibm.webdav 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.ibm.webdav.Response
      com.ibm.webdav.PropertyResponse

PropertyResponse
public class PropertyResponse extends Response implements java.io.Serializable(Code)
A PropertyResponse describes the properties returned as the result of a method send on a resource, e.g., getProperties(). A MultiStatus contains a collection of Response instances, one for each resource effected by the method sent.

PropertyResponse also has convenience methods for all the DAV properties. The method names correspond to the DAV property names suitably modified to fit JavaBean conventions. If the property was not requested, these convenience methods will return null or some other suitable value to indicate the property value is unknown.


author:
   Jim Amsden <jamsden@us.ibm.com>
See Also:   com.ibm.webdav.MethodResponse
See Also:   com.ibm.webdav.MultiStatus



Constructor Summary
public  PropertyResponse(Document document, Element response)
    
public  PropertyResponse(String url)
     Construct an empty Response for some resource.

Method Summary
public  voidaddProperty(PropertyName propertyName, Element propertyElement, int status)
     Add a property and its status to the collection of properties generated as a result of sending a method to a resource.
public  ElementasXML()
     Translate this Response into an XML response element.
public  VectorgetActiveLocks()
     Get the active locks in the property response if any. a Vector of ActiveLock objects containing information about lockson the resource.
public  StringgetAuthor()
     The author of this resource.
public  DategetCheckinDate()
     The date the resource revision was checked in.
public  StringgetComment()
     The comment associated this resource.
public  StringgetContentLanguage()
     The language the content is written in.
public  intgetContentLength()
     The length of the content of the resource or -1 if content length is not applicable.
public  StringgetContentType()
     The MIME content type of the resource.
public  DategetCreationDate()
     The date the resource was created.
public  StringgetDisplayName()
     A name for this resource suitable for display by client applications.
public  StringgetETag()
     The resource entity tag, useful for verifying the state of a cached resource.
public  DategetLastModifiedDate()
     The date on which the resource was last modified.
public  DictionarygetPropertiesByPropName()
     Get all the properties and their statuses in this Response.
public  PropertyValuegetProperty(PropertyName name)
     Get the value of a property contained in a PropertyResponse.
public  DictionarygetPropertyDefinitionsByPropName()
    
public  EnumerationgetPropertyNamesPN()
     Get the names of the properties contained in a PropertyResponse.
public  StringgetResourceType()
     Get the resource type for the resource associated with this PropertyResponse.
public  booleanisOK()
     Check to see if this response does not contain an error.
public  booleanisOnACollection()
     See if this property response is on a collection.
public  voidremoveProperty(PropertyName propertyName)
     Remove a property from the collection of properties generated as a result of sending a method to a resource.
public  voidsetProperty(PropertyName name, PropertyValue value)
     Set the value of a property.
public  PropertyResponsetoPropertyResponse()
     Convert this Response to a PropertyResponse.


Constructor Detail
PropertyResponse
public PropertyResponse(Document document, Element response) throws ServerException(Code)
Construct a Response from an XML DAV:response element
Parameters:
  document - the document that will contain the Responsewhen output as XML.
Parameters:
  response - the XML DAV:response element that is the source
exception:
  com.ibm.webdav.ServerException - thrown if the XML for the response is incorrectof this response



PropertyResponse
public PropertyResponse(String url)(Code)
Construct an empty Response for some resource.
Parameters:
  url - the URL of the resource this is a response for




Method Detail
addProperty
public void addProperty(PropertyName propertyName, Element propertyElement, int status) throws ServerException(Code)
Add a property and its status to the collection of properties generated as a result of sending a method to a resource.
Parameters:
  propertyName - the name of the property to add.
Parameters:
  propertyElement - the value of the property
Parameters:
  status - its status
exception:
  com.ibm.webdav.ServerException - thrown if the property is already in this response



asXML
public Element asXML()(Code)
Translate this Response into an XML response element. a DAV:response XML element



getActiveLocks
public Vector getActiveLocks() throws WebDAVException(Code)
Get the active locks in the property response if any. a Vector of ActiveLock objects containing information about lockson the resource. The Vector will be empty if the lockdiscovery propertywas not requested.
exception:
  com.ibm.webdav.WebDAVException -



getAuthor
public String getAuthor()(Code)
The author of this resource. That is, the principal id of the user agent that initially created the resource. the DAV:author property or null if the property was not requested.



getCheckinDate
public Date getCheckinDate()(Code)
The date the resource revision was checked in. the DAV:checkin-date property or null if the property was not requestedor the resource is not versioned or checked in.



getComment
public String getComment()(Code)
The comment associated this resource. the DAV:comment property or null if the property was not requested.



getContentLanguage
public String getContentLanguage()(Code)
The language the content is written in. the value of the DAV:getcontentlanguage property of null if the property was not requested



getContentLength
public int getContentLength()(Code)
The length of the content of the resource or -1 if content length is not applicable. the DAV:getcontentlength property or -1 if the property was not requested.



getContentType
public String getContentType()(Code)
The MIME content type of the resource. the DAV:getcontenttype property or null if the property was not requested.



getCreationDate
public Date getCreationDate()(Code)
The date the resource was created. the DAV:creationdate property or null if the property was not requested.



getDisplayName
public String getDisplayName()(Code)
A name for this resource suitable for display by client applications. the DAV:displayname property or null if the property was not requested.



getETag
public String getETag()(Code)
The resource entity tag, useful for verifying the state of a cached resource. The DAV:getetag property or null if the property was not requested.



getLastModifiedDate
public Date getLastModifiedDate()(Code)
The date on which the resource was last modified. the DAV:getlastmodified property or null if the property was not requested.



getPropertiesByPropName
public Dictionary getPropertiesByPropName()(Code)
Get all the properties and their statuses in this Response. a Dictionary whose keys are PropertyNames, and whose values arePropertyValues.



getProperty
public PropertyValue getProperty(PropertyName name)(Code)
Get the value of a property contained in a PropertyResponse. The values were set when a method was invoked that returned a MultiStatus containing one or more PropertyResponses.
Parameters:
  name - the name of the property to get, the property value for the named property



getPropertyDefinitionsByPropName
public Dictionary getPropertyDefinitionsByPropName()(Code)



getPropertyNamesPN
public Enumeration getPropertyNamesPN()(Code)
Get the names of the properties contained in a PropertyResponse. The values were set when a method was invoked that returned a MultiStatus containing one or more PropertyResponses. The values here are instances of the class PropertyName... not String.



getResourceType
public String getResourceType()(Code)
Get the resource type for the resource associated with this PropertyResponse. This is the tagName of the first child of the DAV:resourcetype property. The DAV:resourcetype DAV property or null if the property was not requested.



isOK
public boolean isOK()(Code)
Check to see if this response does not contain an error. true if all property statuses are less than 300.



isOnACollection
public boolean isOnACollection()(Code)
See if this property response is on a collection. That is, see if it contains a resourcetype property having a collection element. true if this PropertyResponse is on a collection resource



removeProperty
public void removeProperty(PropertyName propertyName) throws ServerException(Code)
Remove a property from the collection of properties generated as a result of sending a method to a resource.
Parameters:
  propertyName - the property to remove.
exception:
  com.ibm.webdav.ServerException -



setProperty
public void setProperty(PropertyName name, PropertyValue value)(Code)
Set the value of a property.
Parameters:
  name - the name of the property to set.
Parameters:
  value - the property value for the named property



toPropertyResponse
public PropertyResponse toPropertyResponse()(Code)
Convert this Response to a PropertyResponse. This method is used to convert MethodResponses to PropertyResponses when an error occurred accessing the properties of some member.



Fields inherited from com.ibm.webdav.Response
public static String HTTPVersion(Code)(Java Doc)
protected Document document(Code)(Java Doc)

Methods inherited from com.ibm.webdav.Response
abstract public Element asXML()(Code)(Java Doc)
public String getDescription()(Code)(Java Doc)
public String getResource()(Code)(Java Doc)
abstract public boolean isOK()(Code)(Java Doc)
public static String printNode(Node node)(Code)(Java Doc)
public void setDescription(String value)(Code)(Java Doc)
public void setDocument(Document document)(Code)(Java Doc)
protected void setResource(String url)(Code)(Java Doc)
abstract public PropertyResponse toPropertyResponse()(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.