| package org.apache.sling.hapi.client; |
| |
| /******************************************************************************* |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you 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 |
| * <p> |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * <p> |
| * 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. |
| ******************************************************************************/ |
| |
| import org.apache.http.NameValuePair; |
| import java.util.Set; |
| |
| /** |
| * An HTML item representation. This maps to an html element and contains all the child elements. |
| * The child <i>semantic</i> elements (properties, links, forms) and the Item's metadata (src, href, value) |
| * are accessible through the dedicated methods |
| */ |
| public interface Item { |
| /** |
| * Returns the property of the item having the given name. The property is a child Item. |
| */ |
| Items prop(String name) throws ClientException; |
| |
| /** |
| * Return a List of all the properties of this item. |
| * The returned Strings are names that can be used for {@link #prop(String)} |
| */ |
| Set<String> props() throws ClientException; |
| |
| /** |
| * Returns the child links that have the given relation |
| */ |
| Items link(String rel) throws ClientException; |
| |
| /** |
| * Returns all the child links |
| */ |
| Items link() throws ClientException; |
| |
| /** |
| * Returns the child forms that have the given relation |
| */ |
| Items form(String rel) throws ClientException; |
| |
| /** |
| * Returns all the child forms |
| */ |
| Items form() throws ClientException; |
| |
| /** |
| * Returns the text value of the property. |
| */ |
| String text() throws ClientException; |
| |
| /** |
| * Returns he boolean value of the property |
| */ |
| boolean bool() throws ClientException; |
| |
| int number() throws ClientException; |
| |
| /** |
| * Returns the href value of the property. This only makes sense for hyperlinks (<a> or <link>). |
| */ |
| String href(); |
| |
| /** |
| * Returns the <i>src</i> value of the property. |
| */ |
| String src(); |
| |
| /** |
| * Follow a hyperlink and get a new {@link Document} representation |
| */ |
| Document follow() throws ClientException; |
| |
| /** |
| * Submits this form item and returns a new {@link Document} representation |
| */ |
| Document submit(Iterable<NameValuePair> data) throws ClientException; |
| } |